Skip to content

Commit

Permalink
fix: Page order sequence for git import (appsmithorg#13126)
Browse files Browse the repository at this point in the history 
* Added page sequence to metadata

* Update test resources

* Add null check for the pageOrder List

* FIx NPE

* Add logic to handle page order for deployed version

* Add tests for the page order

* Add null check for published pages

* Fix unpublished page names getting added in the order list for published

* update the variable name

* Use published page order in tests for published view

* Fix NPE
  • Loading branch information
@AnaghHegde
AnaghHegde committed Apr 27, 2022
1 parent 3b28ce0 commit 456b5b9
Show file tree
Hide file tree
Showing 11 changed files with 216 additions and 16 deletions.
4 changes: 4 additions & 0 deletions app/server/appsmith-server/src/main/java/com/appsmith/server/domains/ApplicationJson.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ public class ApplicationJson {

List<NewPage> pageList;

List<String> pageOrder;

List<String> publishedPageOrder;

String publishedDefaultPageName;

String unpublishedDefaultPageName;
Expand Down
59 changes: 49 additions & 10 deletions .../src/main/java/com/appsmith/server/solutions/ce/ImportExportApplicationServiceCEImpl.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;

Expand Down Expand Up @@ -233,6 +234,7 @@ public Mono<ApplicationJson> exportApplicationById(String applicationId, Seriali
// Refactor application to remove the ids
final String organizationId = application.getOrganizationId();
List<String> pageOrderList = application.getPages().stream().map(applicationPage -> applicationPage.getId()).collect(Collectors.toList());
List<String> publishedPageOrderList = application.getPublishedPages().stream().map(applicationPage -> applicationPage.getId()).collect(Collectors.toList());
removeUnwantedFieldsFromApplicationDuringExport(application);
examplesOrganizationCloner.makePristine(application);
applicationJson.setExportedApplication(application);
Expand All @@ -244,9 +246,24 @@ public Mono<ApplicationJson> exportApplicationById(String applicationId, Seriali

return pageFlux
.collectList()
// Maintain the page order while exporting the application
// Save the page order to json while exporting the application
.flatMap(newPages -> {
Collections.sort(newPages, Comparator.comparing(newPage -> pageOrderList.indexOf(newPage.getId())));
List<String> pageOrder = new ArrayList<>();
for (NewPage page: newPages) {
pageOrder.add(page.getUnpublishedPage().getName());
}
applicationJson.setPageOrder(pageOrder);

List<NewPage> newPageList = newPages;
// When there is difference in number of pages between edit and view mode
newPageList = newPageList.stream().filter(newPage -> !Optional.ofNullable(newPage.getPublishedPage()).isEmpty()).collect(Collectors.toList());
Collections.sort(newPageList, Comparator.comparing(newPage -> publishedPageOrderList.indexOf(newPage.getId())));
pageOrder = new ArrayList<>();
for (NewPage page: newPageList) {
pageOrder.add(page.getPublishedPage().getName());
}
applicationJson.setPublishedPageOrder(pageOrder);
return Mono.just(newPages);
})
.flatMap(newPageList -> {
Expand Down Expand Up @@ -306,7 +323,7 @@ public Mono<ApplicationJson> exportApplicationById(String applicationId, Seriali

Flux<Datasource> datasourceFlux = Boolean.TRUE.equals(application.getExportWithConfiguration())
? datasourceRepository.findAllByOrganizationId(organizationId, AclPermission.READ_DATASOURCES)
: datasourceRepository.findAllByOrganizationId(organizationId, AclPermission.MANAGE_DATASOURCES);
: datasourceRepository.findAllByOrganizationId(organizationId, MANAGE_DATASOURCES);

return datasourceFlux.collectList();
})
Expand Down Expand Up @@ -854,15 +871,17 @@ public Mono<Application> importApplicationInOrganization(String organizationId,
existingPagesMono
).collectList()
.map(newPageList -> {
// Check if the pages order match with json file
List<String> pageOrderList = importedNewPageList.stream().map(newPage -> newPage.getUnpublishedPage().getName()).collect(Collectors.toList());
// Sort the unPublished pages based on the json file order only
List<String> pageOrderList;
if(Optional.ofNullable(applicationJson.getPageOrder()).isEmpty()) {
pageOrderList = importedNewPageList.stream().map(newPage -> newPage.getUnpublishedPage().getName()).collect(Collectors.toList());
} else {
pageOrderList = applicationJson.getPageOrder();
}
Collections.sort(newPageList,
Comparator.comparing(newPage -> pageOrderList.indexOf(newPage.getUnpublishedPage().getName())));
for (NewPage newPage : newPageList) {

ApplicationPage unpublishedAppPage = new ApplicationPage();
ApplicationPage publishedAppPage = new ApplicationPage();

if (newPage.getUnpublishedPage() != null && newPage.getUnpublishedPage().getName() != null) {
unpublishedAppPage.setIsDefault(
StringUtils.equals(
Expand All @@ -875,6 +894,27 @@ public Mono<Application> importApplicationInOrganization(String organizationId,
}
pageNameMap.put(newPage.getUnpublishedPage().getName(), newPage);
}
if (unpublishedAppPage.getId() != null && newPage.getUnpublishedPage().getDeletedAt() == null) {
applicationPages.get(PublishType.UNPUBLISHED).add(unpublishedAppPage);
}
}

// Sort the published pages based on the json file order only
List<String> publishedPageOrderList;
if(Optional.ofNullable(applicationJson.getPublishedPageOrder()).isEmpty()) {
publishedPageOrderList = importedNewPageList.stream()
.filter(newPage -> !Optional.ofNullable(newPage.getPublishedPage()).isEmpty())
.map(newPage -> newPage.getPublishedPage().getName()).collect(Collectors.toList());
} else {
publishedPageOrderList = applicationJson.getPublishedPageOrder();
}

// When there is difference in number of pages between edit and view mode
newPageList = newPageList.stream().filter(newPage -> !Optional.ofNullable(newPage.getPublishedPage()).isEmpty()).collect(Collectors.toList());
Collections.sort(newPageList,
Comparator.comparing(newPage -> publishedPageOrderList.indexOf(newPage.getPublishedPage().getName())));
for (NewPage newPage : newPageList) {
ApplicationPage publishedAppPage = new ApplicationPage();

if (newPage.getPublishedPage() != null && newPage.getPublishedPage().getName() != null) {
publishedAppPage.setIsDefault(
Expand All @@ -888,9 +928,7 @@ public Mono<Application> importApplicationInOrganization(String organizationId,
}
pageNameMap.put(newPage.getPublishedPage().getName(), newPage);
}
if (unpublishedAppPage.getId() != null && newPage.getUnpublishedPage().getDeletedAt() == null) {
applicationPages.get(PublishType.UNPUBLISHED).add(unpublishedAppPage);
}

if (publishedAppPage.getId() != null && newPage.getPublishedPage().getDeletedAt() == null) {
applicationPages.get(PublishType.PUBLISHED).add(publishedAppPage);
}
Expand Down Expand Up @@ -929,6 +967,7 @@ public Mono<Application> importApplicationInOrganization(String organizationId,
});
})
.flatMap(applicationPageMap -> {
// set it based on the order for published and unublished pages
importedApplication.setPages(applicationPageMap.get(PublishType.UNPUBLISHED));
importedApplication.setPublishedPages(applicationPageMap.get(PublishType.PUBLISHED));

Expand Down
138 changes: 132 additions & 6 deletions ...rver/src/test/java/com/appsmith/server/solutions/ImportExportApplicationServiceTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2336,12 +2336,12 @@ public void importApplication_datasourceWithSameNameAndPlugin_importedWithValidA

@Test
@WithUserDetails(value = "api_user")
public void exportAndImportApplication_withMultiplePages_PagesOrderIsMaintained() {
public void exportAndImportApplication_withMultiplePagesOrderSameInDeployAndEditMode_PagesOrderIsMaintainedInEditAndViewMode() {
Organization newOrganization = new Organization();
newOrganization.setName("template-org-with-ds");

Application testApplication = new Application();
testApplication.setName("exportApplication_withMultiplePages_PagesOrderIsMaintainedINExportedAppJson");
testApplication.setName("exportAndImportApplication_withMultiplePagesOrderSameInDeployAndEditMode_PagesOrderIsMaintainedInEditAndViewMode");
testApplication.setExportWithConfiguration(true);
testApplication = applicationPageService.createApplication(testApplication, orgId).block();
assert testApplication != null;
Expand All @@ -2359,22 +2359,30 @@ public void exportAndImportApplication_withMultiplePages_PagesOrderIsMaintained(
// Set order for the newly created pages
applicationPageService.reorderPage(testApplication.getId(), page1.getId(), 0, null).block();
applicationPageService.reorderPage(testApplication.getId(), page2.getId(), 1, null).block();
// Deploy the current application
applicationPageService.publish(testApplication.getId(), true).block();

Mono<ApplicationJson> applicationJsonMono = importExportApplicationService.exportApplicationById(testApplication.getId(), "");

StepVerifier
.create(applicationJsonMono)
.assertNext(applicationJson -> {
List<NewPage> pageList = applicationJson.getPageList();
assertThat(pageList.get(0).getUnpublishedPage().getName()).isEqualTo("123");
assertThat(pageList.get(1).getUnpublishedPage().getName()).isEqualTo("abc");
assertThat(pageList.get(2).getUnpublishedPage().getName()).isEqualTo("Page1");
List<String> pageList = applicationJson.getPageOrder();
assertThat(pageList.get(0)).isEqualTo("123");
assertThat(pageList.get(1)).isEqualTo("abc");
assertThat(pageList.get(2)).isEqualTo("Page1");

List<String> publishedPageList = applicationJson.getPublishedPageOrder();
assertThat(publishedPageList.get(0)).isEqualTo("123");
assertThat(publishedPageList.get(1)).isEqualTo("abc");
assertThat(publishedPageList.get(2)).isEqualTo("Page1");
})
.verifyComplete();

ApplicationJson applicationJson = importExportApplicationService.exportApplicationById(testApplication.getId(), "").block();
Application application = importExportApplicationService.importApplicationInOrganization(orgId, applicationJson).block();

// Get the unpublished pages and verify the order
List<ApplicationPage> pageDTOS = application.getPages();
Mono<NewPage> newPageMono1 = newPageService.findById(pageDTOS.get(0).getId(), MANAGE_PAGES);
Mono<NewPage> newPageMono2 = newPageService.findById(pageDTOS.get(1).getId(), MANAGE_PAGES);
Expand All @@ -2396,6 +2404,124 @@ public void exportAndImportApplication_withMultiplePages_PagesOrderIsMaintained(
})
.verifyComplete();

// Get the published pages
List<ApplicationPage> publishedPageDTOs = application.getPublishedPages();
Mono<NewPage> newPublishedPageMono1 = newPageService.findById(publishedPageDTOs.get(0).getId(), MANAGE_PAGES);
Mono<NewPage> newPublishedPageMono2 = newPageService.findById(publishedPageDTOs.get(1).getId(), MANAGE_PAGES);
Mono<NewPage> newPublishedPageMono3 = newPageService.findById(publishedPageDTOs.get(2).getId(), MANAGE_PAGES);

StepVerifier
.create(Mono.zip(newPublishedPageMono1, newPublishedPageMono2, newPublishedPageMono3))
.assertNext(objects -> {
NewPage newPage1 = objects.getT1();
NewPage newPage2 = objects.getT2();
NewPage newPage3 = objects.getT3();
assertThat(newPage1.getPublishedPage().getName()).isEqualTo("123");
assertThat(newPage2.getPublishedPage().getName()).isEqualTo("abc");
assertThat(newPage3.getPublishedPage().getName()).isEqualTo("Page1");

assertThat(newPage1.getId()).isEqualTo(publishedPageDTOs.get(0).getId());
assertThat(newPage2.getId()).isEqualTo(publishedPageDTOs.get(1).getId());
assertThat(newPage3.getId()).isEqualTo(publishedPageDTOs.get(2).getId());
})
.verifyComplete();

}


@Test
@WithUserDetails(value = "api_user")
public void exportAndImportApplication_withMultiplePagesOrderDifferentInDeployAndEditMode_PagesOrderIsMaintainedInEditAndViewMode() {
Organization newOrganization = new Organization();
newOrganization.setName("template-org-with-ds");

Application testApplication = new Application();
testApplication.setName("exportAndImportApplication_withMultiplePagesOrderDifferentInDeployAndEditMode_PagesOrderIsMaintainedInEditAndViewMode");
testApplication.setExportWithConfiguration(true);
testApplication = applicationPageService.createApplication(testApplication, orgId).block();
assert testApplication != null;

PageDTO testPage = new PageDTO();
testPage.setName("123");
testPage.setApplicationId(testApplication.getId());
PageDTO page1 = applicationPageService.createPage(testPage).block();

testPage = new PageDTO();
testPage.setName("abc");
testPage.setApplicationId(testApplication.getId());
PageDTO page2 = applicationPageService.createPage(testPage).block();

// Deploy the current application so that edit and view mode will have different page order
applicationPageService.publish(testApplication.getId(), true).block();

// Set order for the newly created pages
applicationPageService.reorderPage(testApplication.getId(), page1.getId(), 0, null).block();
applicationPageService.reorderPage(testApplication.getId(), page2.getId(), 1, null).block();

Mono<ApplicationJson> applicationJsonMono = importExportApplicationService.exportApplicationById(testApplication.getId(), "");

StepVerifier
.create(applicationJsonMono)
.assertNext(applicationJson -> {
List<String> pageList = applicationJson.getPageOrder();
assertThat(pageList.get(0)).isEqualTo("123");
assertThat(pageList.get(1)).isEqualTo("abc");
assertThat(pageList.get(2)).isEqualTo("Page1");

List<String> publishedPageOrder = applicationJson.getPageOrder();
assertThat(publishedPageOrder.get(0)).isEqualTo("123");
assertThat(publishedPageOrder.get(1)).isEqualTo("abc");
assertThat(publishedPageOrder.get(2)).isEqualTo("Page1");
})
.verifyComplete();

ApplicationJson applicationJson = importExportApplicationService.exportApplicationById(testApplication.getId(), "").block();
Application application = importExportApplicationService.importApplicationInOrganization(orgId, applicationJson).block();

// Get the unpublished pages and verify the order
List<ApplicationPage> pageDTOS = application.getPages();
Mono<NewPage> newPageMono1 = newPageService.findById(pageDTOS.get(0).getId(), MANAGE_PAGES);
Mono<NewPage> newPageMono2 = newPageService.findById(pageDTOS.get(1).getId(), MANAGE_PAGES);
Mono<NewPage> newPageMono3 = newPageService.findById(pageDTOS.get(2).getId(), MANAGE_PAGES);

StepVerifier
.create(Mono.zip(newPageMono1, newPageMono2, newPageMono3))
.assertNext(objects -> {
NewPage newPage1 = objects.getT1();
NewPage newPage2 = objects.getT2();
NewPage newPage3 = objects.getT3();
assertThat(newPage1.getUnpublishedPage().getName()).isEqualTo("123");
assertThat(newPage2.getUnpublishedPage().getName()).isEqualTo("abc");
assertThat(newPage3.getUnpublishedPage().getName()).isEqualTo("Page1");

assertThat(newPage1.getId()).isEqualTo(pageDTOS.get(0).getId());
assertThat(newPage2.getId()).isEqualTo(pageDTOS.get(1).getId());
assertThat(newPage3.getId()).isEqualTo(pageDTOS.get(2).getId());
})
.verifyComplete();

// Get the published pages
List<ApplicationPage> publishedPageDTOs = application.getPublishedPages();
Mono<NewPage> newPublishedPageMono1 = newPageService.findById(publishedPageDTOs.get(0).getId(), MANAGE_PAGES);
Mono<NewPage> newPublishedPageMono2 = newPageService.findById(publishedPageDTOs.get(1).getId(), MANAGE_PAGES);
Mono<NewPage> newPublishedPageMono3 = newPageService.findById(publishedPageDTOs.get(2).getId(), MANAGE_PAGES);

StepVerifier
.create(Mono.zip(newPublishedPageMono1, newPublishedPageMono2, newPublishedPageMono3))
.assertNext(objects -> {
NewPage newPage1 = objects.getT1();
NewPage newPage2 = objects.getT2();
NewPage newPage3 = objects.getT3();
assertThat(newPage1.getPublishedPage().getName()).isEqualTo("Page1");
assertThat(newPage2.getPublishedPage().getName()).isEqualTo("123");
assertThat(newPage3.getPublishedPage().getName()).isEqualTo("abc");

assertThat(newPage1.getId()).isEqualTo(publishedPageDTOs.get(0).getId());
assertThat(newPage2.getId()).isEqualTo(publishedPageDTOs.get(1).getId());
assertThat(newPage3.getId()).isEqualTo(publishedPageDTOs.get(2).getId());
})
.verifyComplete();

}

}
4 changes: 4 additions & 0 deletions ..._assets/ImportExportServiceTest/invalid-application-without-pageId-action-collection.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,10 @@
"new": true
}
],
"pageOrder": [
"Page1",
"Page2"
],
"actionList": [
{
"id": "60aca092136c4b7178f6790a",
Expand Down
4 changes: 4 additions & 0 deletions ...t/resources/test_assets/ImportExportServiceTest/valid-application-with-custom-themes.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,10 @@
"new": true
}
],
"pageOrder": [
"Page1",
"Page2"
],
"actionList": [
{
"id": "60aca092136c4b7178f6790a",
Expand Down
5 changes: 5 additions & 0 deletions ...test/resources/test_assets/ImportExportServiceTest/valid-application-with-page-added.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -541,6 +541,11 @@
"new": true
}
],
"pageOrder": [
"Page1",
"Page2",
"Page3"
],
"publishedDefaultPageName": "Page1",
"unpublishedDefaultPageName": "Page1",
"actionList": [
Expand Down
Loading

0 comments on commit 456b5b9

Please sign in to comment.