api for updating editing state

Thomasr · ludomikula · commit fbdbb54d9258 · 2024-08-20T09:28:29.000+02:00
diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/application/service/ApplicationService.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/application/service/ApplicationService.java
@@ -23,6 +23,8 @@ public interface ApplicationService {
 
     Mono<Application> publish(String applicationId);
 
+    Mono<Boolean> updateEditState(String applicationId, Boolean editingFinished);
+
     Mono<Application> create(Application newApplication, String visitorId);
 
     Flux<Application> findByOrganizationIdWithDsl(String organizationId);
diff --git a/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/application/service/ApplicationServiceImpl.java b/server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/application/service/ApplicationServiceImpl.java
@@ -93,6 +93,16 @@ public Mono<Application> publish(String applicationId) {
                 });
     }
 
+    @Override
+    public Mono<Boolean> updateEditState(String applicationId, Boolean editingFinished) {
+        return findById(applicationId)
+                .flatMap(newApplication -> {
+                    Application application = Application.builder().editingUserId("").build();
+                    if(editingFinished) return mongoUpsertHelper.updateById(application, applicationId);
+                    return Mono.just(true);
+                });
+    }
+
     @Override
     public Mono<Application> create(Application newApplication, String visitorId) {
         return repository.save(newApplication)
diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationApiService.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationApiService.java
@@ -35,6 +35,8 @@ public interface ApplicationApiService {
 
     Mono<ApplicationView> publish(String applicationId);
 
+    Mono<Boolean> updateEditState(String applicationId, ApplicationEndpoints.UpdateEditStateRequest updateEditStateRequest);
+
     Mono<Boolean> grantPermission(String applicationId,
                                   Set<String> userIds,
                                   Set<String> groupIds, ResourceRole role);
diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationApiServiceImpl.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationApiServiceImpl.java
@@ -371,6 +371,15 @@ public Mono<ApplicationView> publish(String applicationId) {
                                 .build()));
     }
 
+    @Override
+    public Mono<Boolean> updateEditState(String applicationId, ApplicationEndpoints.UpdateEditStateRequest updateEditStateRequest) {
+        return checkApplicationStatus(applicationId, NORMAL)
+                .then(sessionUserService.getVisitorId())
+                .flatMap(userId -> resourcePermissionService.checkAndReturnMaxPermission(userId,
+                        applicationId, EDIT_APPLICATIONS))
+                .flatMap(permission -> applicationService.updateEditState(applicationId, updateEditStateRequest.editingFinished()));
+    }
+
     @Override
     public Mono<Boolean> grantPermission(String applicationId,
                                          Set<String> userIds,
diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationController.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationController.java
@@ -142,6 +142,13 @@ public Mono<ResponseView<ApplicationView>> publish(@PathVariable String applicat
                 .map(ResponseView::success);
     }
 
+    @Override
+    public Mono<ResponseView<Boolean>> updateEditState(@PathVariable String applicationId, @RequestBody UpdateEditStateRequest updateEditStateRequest) {
+        String appId = gidService.convertApplicationIdToObjectId(applicationId);
+        return applicationApiService.updateEditState(appId, updateEditStateRequest)
+                .map(ResponseView::success);
+    }
+
     @Override
     public Mono<ResponseView<UserHomepageView>> getUserHomePage(@RequestParam(required = false, defaultValue = "0") int applicationType) {
         ApplicationType type = ApplicationType.fromValue(applicationType);
diff --git a/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationEndpoints.java b/server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/application/ApplicationEndpoints.java
@@ -137,6 +137,16 @@ public Mono<ResponseView<ApplicationView>> update(@PathVariable String applicati
     @PostMapping("/{applicationId}/publish")
     public Mono<ResponseView<ApplicationView>> publish(@PathVariable String applicationId);
 
+	@Operation(
+			tags = TAG_APPLICATION_MANAGEMENT,
+			operationId = "updateApplicationEditingState",
+			summary = "Update Application editing state",
+			description = "Update the editing state of a specific Lowcoder Application identified by its ID."
+	)
+	@PutMapping("/editState/{applicationId}")
+	public Mono<ResponseView<Boolean>> updateEditState(@PathVariable String applicationId,
+														@RequestBody UpdateEditStateRequest updateEditStateRequest);
+
 	@Operation(
 			tags = TAG_APPLICATION_MANAGEMENT,
 		    operationId = "getUserHomepageApplication",
@@ -285,5 +295,7 @@ public record CreateApplicationRequest(@JsonProperty("orgId") String organizatio
                                            Map<String, Object> editingApplicationDSL,
                                            @Nullable String folderId) {
     }
+	public record UpdateEditStateRequest(Boolean editingFinished) {
+	}
 
 }
diff --git a/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/application/ApplicationApiServiceIntegrationTest.java b/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/application/ApplicationApiServiceIntegrationTest.java
@@ -1,6 +1,7 @@
 package org.lowcoder.api.application;
 
 
+import jakarta.persistence.Tuple;
 import lombok.extern.slf4j.Slf4j;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
@@ -26,6 +27,7 @@
 import org.springframework.test.context.ActiveProfiles;
 import reactor.core.publisher.Mono;
 import reactor.test.StepVerifier;
+import reactor.util.function.Tuple2;
 
 import java.util.Map;
 import java.util.Set;
@@ -69,7 +71,6 @@ public void testCreateApplicationSuccess() {
         //
         Mono<ApplicationView> applicationViewMono = datasourceMono.map(datasource -> new CreateApplicationRequest(
                         "org01",
-                        "",
                         "app05",
                         ApplicationType.APPLICATION.getValue(),
                         Map.of("comp", "table"),
@@ -105,7 +106,6 @@ public void testUpdateApplicationFailedDueToLackOfDatasourcePermissions() {
         //
         Mono<ApplicationView> applicationViewMono = datasourceMono.map(datasource -> new CreateApplicationRequest(
                         "org01",
-                        "",
                         "app03",
                         ApplicationType.APPLICATION.getValue(),
                         Map.of("comp", "table"),
@@ -127,4 +127,17 @@ public void testUpdateApplicationFailedDueToLackOfDatasourcePermissions() {
                         && bizException.getMessageKey().equals("APPLICATION_EDIT_ERROR_LACK_OF_DATASOURCE_PERMISSIONS"))
                 .verify();
     }
+
+    @Test
+    @WithMockUser
+    public void testUpdateEditingStateSuccess() {
+        Mono<ApplicationView> applicationViewMono = applicationApiService.create(new CreateApplicationRequest("org01", "app1", ApplicationType.APPLICATION.getValue(), null, null, null));
+        Mono<ApplicationView> updateEditStateMono = applicationViewMono.delayUntil(app -> applicationApiService.updateEditState(app.getApplicationInfoView().getApplicationId(), new ApplicationEndpoints.UpdateEditStateRequest(true)));
+        Mono<ApplicationView> app = updateEditStateMono.flatMap(applicationView -> applicationApiService.getEditingApplication(applicationView.getApplicationInfoView().getApplicationId()));
+        StepVerifier.create(app)
+                .assertNext(application -> {
+                    Assertions.assertEquals("", application.getApplicationInfoView().getEditingUserId());
+                })
+                .verifyComplete();
+    }
 }
diff --git a/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/application/ApplicationApiServiceTest.java b/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/application/ApplicationApiServiceTest.java
@@ -125,7 +125,7 @@ public void testDeleteNormalApplicationWithError() {
 
     private Mono<ApplicationView> createApplication(String name, String folderId) {
         CreateApplicationRequest createApplicationRequest =
-                new CreateApplicationRequest("org01", "", name, ApplicationType.APPLICATION.getValue(),
+                new CreateApplicationRequest("org01", name, ApplicationType.APPLICATION.getValue(),
                         Map.of("comp", "table"), Map.of("comp", "list"), folderId);
         return applicationApiService.create(createApplicationRequest);
     }
diff --git a/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/common/TestRedisConfiguration.java b/server/api-service/lowcoder-server/src/test/java/org/lowcoder/api/common/TestRedisConfiguration.java
@@ -10,7 +10,7 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 @SuppressWarnings("UnstableApiUsage")
-@TestConfiguration
+//@TestConfiguration
 public class TestRedisConfiguration {
 
     private static final AtomicInteger STATE = new AtomicInteger(0);

Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ public void testDeleteNormalApplicationWithError() {`
`125`	`125`
`126`	`126`	`private Mono<ApplicationView> createApplication(String name, String folderId) {`
`127`	`127`	`CreateApplicationRequest createApplicationRequest =`
`128`		`- new CreateApplicationRequest("org01", "", name, ApplicationType.APPLICATION.getValue(),`
	`128`	`+ new CreateApplicationRequest("org01", name, ApplicationType.APPLICATION.getValue(),`
`129`	`129`	`Map.of("comp", "table"), Map.of("comp", "list"), folderId);`
`130`	`130`	`return applicationApiService.create(createApplicationRequest);`
`131`	`131`	`}`