From b6adbd6ec8ed7ff3b4eaf6b83a540b45571936a2 Mon Sep 17 00:00:00 2001 From: dashevchenko Date: Tue, 21 Mar 2023 13:29:46 +0200 Subject: [PATCH] moved logic to DefaultTbAlarmCommentService --- .../controller/AlarmCommentController.java | 7 ++---- .../alarm/DefaultTbAlarmCommentService.java | 16 ++++++++++--- .../entitiy/alarm/TbAlarmCommentService.java | 2 +- .../DefaultTbAlarmCommentServiceTest.java | 23 ++++++++++++++++--- .../server/dao/alarm/AlarmCommentService.java | 2 +- .../dao/alarm/BaseAlarmCommentService.java | 18 ++++----------- .../service/BaseAlarmCommentServiceTest.java | 13 ++++------- 7 files changed, 46 insertions(+), 35 deletions(-) diff --git a/application/src/main/java/org/thingsboard/server/controller/AlarmCommentController.java b/application/src/main/java/org/thingsboard/server/controller/AlarmCommentController.java index 46ce177481..92b2cb923f 100644 --- a/application/src/main/java/org/thingsboard/server/controller/AlarmCommentController.java +++ b/application/src/main/java/org/thingsboard/server/controller/AlarmCommentController.java @@ -90,7 +90,7 @@ public class AlarmCommentController extends BaseController { public void deleteAlarmComment(@ApiParam(value = ALARM_ID_PARAM_DESCRIPTION) @PathVariable(ALARM_ID) String strAlarmId, @ApiParam(value = ALARM_COMMENT_ID_PARAM_DESCRIPTION) @PathVariable(ALARM_COMMENT_ID) String strCommentId) throws ThingsboardException { checkParameter(ALARM_ID, strAlarmId); AlarmId alarmId = new AlarmId(toUUID(strAlarmId)); - Alarm alarm = checkAlarmId(alarmId, Operation.DELETE); + Alarm alarm = checkAlarmId(alarmId, Operation.WRITE); AlarmCommentId alarmCommentId = new AlarmCommentId(toUUID(strCommentId)); AlarmComment alarmComment = checkAlarmCommentId(alarmCommentId, alarmId); @@ -117,10 +117,7 @@ public class AlarmCommentController extends BaseController { ) throws Exception { checkParameter(ALARM_ID, strAlarmId); AlarmId alarmId = new AlarmId(toUUID(strAlarmId)); - Alarm alarm = alarmService.findAlarmByIdAsync(getCurrentUser().getTenantId(), alarmId).get(); - checkNotNull(alarm, "Alarm with id [" + alarmId + "] is not found"); - checkEntityId(alarm.getOriginator(), Operation.READ); - + Alarm alarm = checkAlarmId(alarmId, Operation.READ); PageLink pageLink = createPageLink(pageSize, page, null, sortProperty, sortOrder); return checkNotNull(alarmCommentService.findAlarmComments(alarm.getTenantId(), alarmId, pageLink)); } diff --git a/application/src/main/java/org/thingsboard/server/service/entitiy/alarm/DefaultTbAlarmCommentService.java b/application/src/main/java/org/thingsboard/server/service/entitiy/alarm/DefaultTbAlarmCommentService.java index 045714d58a..0e289f73f3 100644 --- a/application/src/main/java/org/thingsboard/server/service/entitiy/alarm/DefaultTbAlarmCommentService.java +++ b/application/src/main/java/org/thingsboard/server/service/entitiy/alarm/DefaultTbAlarmCommentService.java @@ -24,6 +24,7 @@ import org.thingsboard.server.common.data.alarm.Alarm; import org.thingsboard.server.common.data.alarm.AlarmComment; import org.thingsboard.server.common.data.alarm.AlarmCommentType; import org.thingsboard.server.common.data.audit.ActionType; +import org.thingsboard.server.common.data.exception.ThingsboardErrorCode; import org.thingsboard.server.common.data.exception.ThingsboardException; import org.thingsboard.server.common.data.id.UserId; import org.thingsboard.server.service.entitiy.AbstractTbEntityService; @@ -47,8 +48,17 @@ public class DefaultTbAlarmCommentService extends AbstractTbEntityService implem } @Override - public void deleteAlarmComment(Alarm alarm, AlarmComment alarmComment, User user) { - alarmCommentService.deleteAlarmComment(alarm.getTenantId(), alarmComment, user); - notificationEntityService.notifyAlarmComment(alarm, alarmComment, ActionType.DELETED_COMMENT, user); + public void deleteAlarmComment(Alarm alarm, AlarmComment alarmComment, User user) throws ThingsboardException { + if (alarmComment.getType() == AlarmCommentType.OTHER) { + alarmComment.setType(AlarmCommentType.SYSTEM); + alarmComment.setUserId(null); + alarmComment.setComment(JacksonUtil.newObjectNode().put("text", + String.format("User %s deleted his comment", + (user.getFirstName() == null || user.getLastName() == null) ? user.getName() : user.getFirstName() + " " + user.getLastName()))); + AlarmComment savedAlarmComment = checkNotNull(alarmCommentService.saveAlarmComment(alarm.getTenantId(), alarmComment)); + notificationEntityService.notifyAlarmComment(alarm, savedAlarmComment, ActionType.DELETED_COMMENT, user); + } else { + throw new ThingsboardException("System comment could not be deleted", ThingsboardErrorCode.BAD_REQUEST_PARAMS); + } } } diff --git a/application/src/main/java/org/thingsboard/server/service/entitiy/alarm/TbAlarmCommentService.java b/application/src/main/java/org/thingsboard/server/service/entitiy/alarm/TbAlarmCommentService.java index 8c6aa3366a..a2bca133cb 100644 --- a/application/src/main/java/org/thingsboard/server/service/entitiy/alarm/TbAlarmCommentService.java +++ b/application/src/main/java/org/thingsboard/server/service/entitiy/alarm/TbAlarmCommentService.java @@ -23,5 +23,5 @@ import org.thingsboard.server.common.data.exception.ThingsboardException; public interface TbAlarmCommentService { AlarmComment saveAlarmComment(Alarm alarm, AlarmComment alarmComment, User user) throws ThingsboardException; - void deleteAlarmComment(Alarm alarm, AlarmComment alarmComment, User user); + void deleteAlarmComment(Alarm alarm, AlarmComment alarmComment, User user) throws ThingsboardException; } diff --git a/application/src/test/java/org/thingsboard/server/service/entitiy/alarmComment/DefaultTbAlarmCommentServiceTest.java b/application/src/test/java/org/thingsboard/server/service/entitiy/alarmComment/DefaultTbAlarmCommentServiceTest.java index f00008fc5e..1377b1a934 100644 --- a/application/src/test/java/org/thingsboard/server/service/entitiy/alarmComment/DefaultTbAlarmCommentServiceTest.java +++ b/application/src/test/java/org/thingsboard/server/service/entitiy/alarmComment/DefaultTbAlarmCommentServiceTest.java @@ -28,9 +28,11 @@ import org.thingsboard.server.cluster.TbClusterService; import org.thingsboard.server.common.data.User; import org.thingsboard.server.common.data.alarm.Alarm; import org.thingsboard.server.common.data.alarm.AlarmComment; +import org.thingsboard.server.common.data.alarm.AlarmCommentType; import org.thingsboard.server.common.data.exception.ThingsboardException; import org.thingsboard.server.common.data.id.AlarmCommentId; import org.thingsboard.server.common.data.id.AlarmId; +import org.thingsboard.server.common.data.id.UserId; import org.thingsboard.server.dao.alarm.AlarmCommentService; import org.thingsboard.server.dao.alarm.AlarmService; import org.thingsboard.server.dao.customer.CustomerService; @@ -41,6 +43,7 @@ import org.thingsboard.server.service.telemetry.AlarmSubscriptionService; import java.util.UUID; +import static org.assertj.core.api.Assertions.assertThatThrownBy; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.eq; import static org.mockito.Mockito.doNothing; @@ -84,14 +87,28 @@ public class DefaultTbAlarmCommentServiceTest { } @Test - public void testDelete() { + public void testDelete() throws ThingsboardException { var alarmId = new AlarmId(UUID.randomUUID()); var alarmComment = new AlarmComment(); alarmComment.setAlarmId(alarmId); + alarmComment.setUserId(new UserId(UUID.randomUUID())); + alarmComment.setType(AlarmCommentType.OTHER); - doNothing().when(alarmCommentService).deleteAlarmComment(Mockito.any(), eq(alarmComment), Mockito.any()); - service.deleteAlarmComment(new Alarm(alarmId), new AlarmComment(), new User()); + when(alarmCommentService.saveAlarmComment(Mockito.any(), eq(alarmComment))).thenReturn(alarmComment); + service.deleteAlarmComment(new Alarm(alarmId), alarmComment, new User()); verify(notificationEntityService, times(1)).notifyAlarmComment(any(), any(), any(), any()); } + + @Test + public void testShouldNotDeleteSystemComment() { + var alarmId = new AlarmId(UUID.randomUUID()); + var alarmComment = new AlarmComment(); + alarmComment.setAlarmId(alarmId); + alarmComment.setType(AlarmCommentType.SYSTEM); + + assertThatThrownBy(() -> service.deleteAlarmComment(new Alarm(alarmId), alarmComment, new User())) + .isInstanceOf(ThingsboardException.class) + .hasMessageContaining("System comment could not be deleted"); + } } \ No newline at end of file diff --git a/common/dao-api/src/main/java/org/thingsboard/server/dao/alarm/AlarmCommentService.java b/common/dao-api/src/main/java/org/thingsboard/server/dao/alarm/AlarmCommentService.java index 3aa2972b14..90fbc09fcf 100644 --- a/common/dao-api/src/main/java/org/thingsboard/server/dao/alarm/AlarmCommentService.java +++ b/common/dao-api/src/main/java/org/thingsboard/server/dao/alarm/AlarmCommentService.java @@ -28,7 +28,7 @@ import org.thingsboard.server.common.data.page.PageLink; public interface AlarmCommentService { AlarmComment createOrUpdateAlarmComment(TenantId tenantId, AlarmComment alarmComment); - void deleteAlarmComment(TenantId tenantId, AlarmComment alarmComment, User user); + AlarmComment saveAlarmComment(TenantId tenantId, AlarmComment alarmComment); PageData findAlarmComments(TenantId tenantId, AlarmId alarmId, PageLink pageLink); diff --git a/dao/src/main/java/org/thingsboard/server/dao/alarm/BaseAlarmCommentService.java b/dao/src/main/java/org/thingsboard/server/dao/alarm/BaseAlarmCommentService.java index 3a0784407e..6c6cc18355 100644 --- a/dao/src/main/java/org/thingsboard/server/dao/alarm/BaseAlarmCommentService.java +++ b/dao/src/main/java/org/thingsboard/server/dao/alarm/BaseAlarmCommentService.java @@ -43,7 +43,7 @@ import static org.thingsboard.server.dao.service.Validator.validateId; @Service @Slf4j -public class BaseAlarmCommentService extends AbstractEntityService implements AlarmCommentService{ +public class BaseAlarmCommentService extends AbstractEntityService implements AlarmCommentService { @Autowired private AlarmCommentDao alarmCommentDao; @@ -62,20 +62,10 @@ public class BaseAlarmCommentService extends AbstractEntityService implements Al } @Override - public void deleteAlarmComment(TenantId tenantId, AlarmComment alarmComment, User user) { + public AlarmComment saveAlarmComment(TenantId tenantId, AlarmComment alarmComment) { log.debug("Deleting Alarm Comment: {}", alarmComment); - - if (alarmComment.getType() == AlarmCommentType.OTHER) { - alarmComment.setType(AlarmCommentType.SYSTEM); - alarmComment.setUserId(null); - alarmComment.setComment(JacksonUtil.newObjectNode().put("text", - String.format("User %s deleted his comment", - (user.getFirstName() == null || user.getLastName() == null) ? user.getName() : user.getFirstName() + " " + user.getLastName()))); - alarmCommentDao.save(tenantId, alarmComment); - } - else { - alarmCommentDao.deleteAlarmComment(tenantId, alarmComment.getId()); - } + alarmCommentDataValidator.validate(alarmComment, c -> tenantId); + return alarmCommentDao.save(tenantId, alarmComment); } @Override diff --git a/dao/src/test/java/org/thingsboard/server/dao/service/BaseAlarmCommentServiceTest.java b/dao/src/test/java/org/thingsboard/server/dao/service/BaseAlarmCommentServiceTest.java index 6ff4211249..e79e00515b 100644 --- a/dao/src/test/java/org/thingsboard/server/dao/service/BaseAlarmCommentServiceTest.java +++ b/dao/src/test/java/org/thingsboard/server/dao/service/BaseAlarmCommentServiceTest.java @@ -80,7 +80,7 @@ public abstract class BaseAlarmCommentServiceTest extends AbstractServiceTest { @Test - public void testSaveAndFetchAlarmComment() throws ExecutionException, InterruptedException { + public void testCreateAndFetchAlarmComment() throws ExecutionException, InterruptedException { AlarmComment alarmComment = AlarmComment.builder().alarmId(alarm.getId()) .userId(user.getId()) .type(OTHER) @@ -143,7 +143,7 @@ public abstract class BaseAlarmCommentServiceTest extends AbstractServiceTest { } @Test - public void testDeleteAlarmComment() throws ExecutionException, InterruptedException { + public void testSaveAlarmComment() throws ExecutionException, InterruptedException { UserId userId = new UserId(UUID.randomUUID()); AlarmComment alarmComment = AlarmComment.builder().alarmId(alarm.getId()) .userId(userId) @@ -153,15 +153,12 @@ public abstract class BaseAlarmCommentServiceTest extends AbstractServiceTest { AlarmComment createdComment = alarmCommentService.createOrUpdateAlarmComment(tenantId, alarmComment); - Assert.assertNotNull(createdComment); - Assert.assertNotNull(createdComment.getId()); - - alarmCommentService.deleteAlarmComment(tenantId, createdComment, user); + createdComment.setType(AlarmCommentType.SYSTEM); + createdComment.setUserId(null); + alarmCommentService.saveAlarmComment(tenantId, createdComment); AlarmComment fetched = alarmCommentService.findAlarmCommentByIdAsync(tenantId, createdComment.getId()).get(); Assert.assertNull(fetched.getUserId()); Assert.assertEquals(AlarmCommentType.SYSTEM, fetched.getType()); - Assert.assertEquals(fetched.getComment().get("text").asText(), String.format("User %s deleted his comment", - (user.getFirstName() == null || user.getLastName() == null) ? user.getName() : user.getFirstName() + " " + user.getLastName())); } }