Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: skipped unnecessary code for js object updates #37125

Merged
merged 5 commits into from
Nov 6, 2024
Merged

fix: skipped unnecessary code for js object updates #37125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
04b4b87
fix: skipped unnecessary code for js object updates
Oct 29, 2024
cdd2e38
fix: updated test case name and comments
Oct 30, 2024
0b19764
fix: test case added to assert error reports
Nov 5, 2024
ed54f78
Merge branch 'release' into fix/skip-redudant-code-from-js-object-update
Nov 5, 2024
9fbde99
fix: code review comments
Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 34 additions & 30 deletions ...smith-server/src/main/java/com/appsmith/server/services/ce/LayoutActionServiceCEImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,36 +249,40 @@ protected Mono<ActionDTO> updateActionBasedOnContextType(NewAction newAction, Ac
String pageId = newAction.getUnpublishedAction().getPageId();
action.setApplicationId(null);
action.setPageId(null);
return updateSingleAction(newAction.getId(), action)
.name(UPDATE_SINGLE_ACTION)
.tap(Micrometer.observation(observationRegistry))
.flatMap(updatedAction -> {
// Update page layout is skipped for JS actions here because when JSobject is updated, we first
// update all actions, action
// collection and then we update the page layout, hence updating page layout with each action update
// is not required here
if (action.getPluginType() != PluginType.JS) {
return updateLayoutService
.updatePageLayoutsByPageId(pageId)
.name(UPDATE_PAGE_LAYOUT_BY_PAGE_ID)
.tap(Micrometer.observation(observationRegistry))
.thenReturn(updatedAction);
}
return Mono.just(updatedAction);
})
.zipWhen(actionDTO -> newPageService.findPageById(pageId, pagePermission.getEditPermission(), false))
.map(tuple2 -> {
ActionDTO actionDTO = tuple2.getT1();
PageDTO pageDTO = tuple2.getT2();
// redundant check
if (pageDTO.getLayouts().size() > 0) {
actionDTO.setErrorReports(pageDTO.getLayouts().get(0).getLayoutOnLoadActionErrors());
}
log.debug(
"Update action based on context type completed, returning actionDTO with action id: {}",
actionDTO != null ? actionDTO.getId() : null);
return actionDTO;
});

// Update page layout is skipped for JS actions here because when JSobject is updated, we first
// update all actions, action
// collection and then we update the page layout, hence updating page layout with each action update
// is not required here
if (action.getPluginType() == PluginType.JS) {
return updateSingleAction(newAction.getId(), action)
.name(UPDATE_SINGLE_ACTION)
.tap(Micrometer.observation(observationRegistry));
sneha122 marked this conversation as resolved.
Show resolved Hide resolved
} else {
sneha122 marked this conversation as resolved.
Show resolved Hide resolved
return updateSingleAction(newAction.getId(), action)
.name(UPDATE_SINGLE_ACTION)
.tap(Micrometer.observation(observationRegistry))
.flatMap(updatedAction -> updateLayoutService
.updatePageLayoutsByPageId(pageId)
.name(UPDATE_PAGE_LAYOUT_BY_PAGE_ID)
.tap(Micrometer.observation(observationRegistry))
.thenReturn(updatedAction))
.zipWhen(
actionDTO -> newPageService.findPageById(pageId, pagePermission.getEditPermission(), false))
.map(tuple2 -> {
ActionDTO actionDTO = tuple2.getT1();
PageDTO pageDTO = tuple2.getT2();
// redundant check
if (pageDTO.getLayouts().size() > 0) {
actionDTO.setErrorReports(
pageDTO.getLayouts().get(0).getLayoutOnLoadActionErrors());
}
sneha122 marked this conversation as resolved.
Show resolved Hide resolved
log.debug(
"Update action based on context type completed, returning actionDTO with action id: {}",
actionDTO != null ? actionDTO.getId() : null);
return actionDTO;
});
}
}

@Override
Expand Down
45 changes: 40 additions & 5 deletions ...psmith-server/src/test/java/com/appsmith/server/services/ActionCollectionServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import com.appsmith.server.dtos.PluginWorkspaceDTO;
import com.appsmith.server.dtos.RefactorEntityNameDTO;
import com.appsmith.server.dtos.WorkspacePluginStatus;
import com.appsmith.server.exceptions.AppsmithError;
import com.appsmith.server.helpers.MockPluginExecutor;
import com.appsmith.server.helpers.PluginExecutorHelper;
import com.appsmith.server.layouts.UpdateLayoutService;
Expand Down Expand Up @@ -73,6 +74,7 @@
import static com.appsmith.server.constants.FieldName.VIEWER;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;

@SpringBootTest
@Slf4j
Expand Down Expand Up @@ -708,7 +710,8 @@ public void testDeleteActionCollection_afterApplicationPublish_clearsActionColle

@Test
@WithUserDetails(value = "api_user")
public void testUpdateUnpublishedActionCollection_withValidCollection_callsPageLayoutOnlyOnce() {
public void
testUpdateUnpublishedActionCollection_withValidCollection_callsPageLayoutOnlyOnceAndAssertCyclicDependencyError() {
Mockito.when(pluginExecutorHelper.getPluginExecutor(Mockito.any())).thenReturn(Mono.just(pluginExecutor));
Mockito.when(pluginExecutor.getHintMessages(Mockito.any(), Mockito.any()))
.thenReturn(Mono.zip(Mono.just(new HashSet<>()), Mono.just(new HashSet<>())));
Expand All @@ -727,7 +730,7 @@ public void testUpdateUnpublishedActionCollection_withValidCollection_callsPageL
ActionDTO action1 = new ActionDTO();
action1.setName("testAction1");
action1.setActionConfiguration(new ActionConfiguration());
action1.getActionConfiguration().setBody("mockBody");
action1.getActionConfiguration().setBody("initial body");
action1.getActionConfiguration().setIsValid(false);

ActionDTO action2 = new ActionDTO();
Expand All @@ -744,15 +747,35 @@ public void testUpdateUnpublishedActionCollection_withValidCollection_callsPageL

actionCollectionDTO.setActions(List.of(action1, action2, action3));

Layout layout = testPage.getLayouts().get(0);
ArrayList dslList = (ArrayList) layout.getDsl().get("children");
JSONObject tableDsl = (JSONObject) dslList.get(0);
tableDsl.put("tableData", "{{testCollection1.testAction1.data}}");
JSONArray temp2 = new JSONArray();
temp2.add(new JSONObject(Map.of("key", "tableData")));
tableDsl.put("dynamicBindingPathList", temp2);
JSONArray temp3 = new JSONArray();
temp3.add(new JSONObject(Map.of("key", "tableData")));
tableDsl.put("dynamicPropertyPathList", temp3);
layout.getDsl().put("widgetName", "MainContainer");

testPage.setLayouts(List.of(layout));
PageDTO updatedPage =
newPageService.updatePage(testPage.getId(), testPage).block();

// Create Js object
ActionCollectionDTO createdActionCollectionDTO =
layoutCollectionService.createCollection(actionCollectionDTO).block();
assert createdActionCollectionDTO != null;
assert createdActionCollectionDTO.getId() != null;
String createdActionCollectionId = createdActionCollectionDTO.getId();

applicationPageService.publish(testApp.getId(), true).block();

actionCollectionDTO.getActions().get(0).getActionConfiguration().setBody("updatedBody");
// Update JS object to create cyclic dependency
actionCollectionDTO.getActions().stream()
.filter(action -> "testAction1".equals(action.getName()))
.findFirst()
.ifPresent(action ->
action.getActionConfiguration().setBody("function () {\n return Table1.tableData;\n}"));

final Mono<ActionCollectionDTO> updatedActionCollectionDTO =
layoutCollectionService.updateUnpublishedActionCollection(
Expand All @@ -766,6 +789,18 @@ public void testUpdateUnpublishedActionCollection_withValidCollection_callsPageL
// collection as expected
Mockito.verify(updateLayoutService, Mockito.times(2))
.updatePageLayoutsByPageId(Mockito.anyString());

assertEquals(1, actionCollectionDTO1.getErrorReports().size());
assertEquals(
AppsmithError.CYCLICAL_DEPENDENCY_ERROR.getAppErrorCode(),
actionCollectionDTO1.getErrorReports().get(0).getCode());
sneha122 marked this conversation as resolved.
Show resolved Hide resolved

// Iterate over each action and assert that errorReports is null as action collection already has
// error reports
// it's not required in each action
actionCollectionDTO
.getActions()
.forEach(action -> assertNull(action.getErrorReports(), "Error reports should be null"));
})
.verifyComplete();
}
Expand Down
Loading