Merge pull request #8898 from dashevchenko/resourceDeleteValidation

Resource deletion validation

application/src/main/java/org/thingsboard/server/service/resource/DefaultTbResourceService.java

@@ -27,14 +27,18 @@ import org.thingsboard.server.common.data.TbResourceInfo;
 import org.thingsboard.server.common.data.TbResourceInfoFilter;
 import org.thingsboard.server.common.data.User;
 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.TbResourceId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.lwm2m.LwM2mObject;
 import org.thingsboard.server.common.data.page.PageData;
 import org.thingsboard.server.common.data.page.PageLink;
+import org.thingsboard.server.common.data.widget.BaseWidgetType;
+import org.thingsboard.server.common.data.widget.WidgetTypeDetails;
 import org.thingsboard.server.dao.exception.DataValidationException;
 import org.thingsboard.server.dao.resource.ResourceService;
+import org.thingsboard.server.dao.widget.WidgetTypeService;
 import org.thingsboard.server.queue.util.TbCoreComponent;
 import org.thingsboard.server.service.entitiy.AbstractTbEntityService;
 
@@ -55,9 +59,11 @@ import static org.thingsboard.server.utils.LwM2mObjectModelUtils.toLwm2mResource
 public class DefaultTbResourceService extends AbstractTbEntityService implements TbResourceService {
 
     private final ResourceService resourceService;
+    private final WidgetTypeService widgetTypeService;
 
-    public DefaultTbResourceService(ResourceService resourceService) {
+    public DefaultTbResourceService(ResourceService resourceService, WidgetTypeService widgetTypeService) {
         this.resourceService = resourceService;
+        this.widgetTypeService = widgetTypeService;
     }
 
     @Override

application/src/test/java/org/thingsboard/server/controller/TbResourceControllerTest.java

@@ -38,6 +38,8 @@ import org.thingsboard.server.common.data.audit.ActionType;
 import org.thingsboard.server.common.data.page.PageData;
 import org.thingsboard.server.common.data.page.PageLink;
 import org.thingsboard.server.common.data.security.Authority;
+import org.thingsboard.server.common.data.widget.WidgetTypeDetails;
+import org.thingsboard.server.common.data.widget.WidgetsBundle;
 import org.thingsboard.server.dao.exception.DataValidationException;
 import org.thingsboard.server.dao.service.DaoSqlTest;
 
@@ -216,6 +218,36 @@ public class TbResourceControllerTest extends AbstractControllerTest {
                 .andExpect(statusReason(containsString(msgErrorNoFound("Resource", resourceIdStr))));
     }
 
+    @Test
+    public void testShoudNotDeleteTbResourceIfAssignedToWidgetType() throws Exception {
+        TbResource resource = new TbResource();
+        resource.setResourceType(ResourceType.JKS);
+        resource.setTitle("My first resource");
+        resource.setFileName(DEFAULT_FILE_NAME);
+        resource.setData(TEST_DATA);
+
+        TbResource savedResource = save(resource);
+
+        Mockito.reset(tbClusterService, auditLogService);
+        String resourceIdStr = savedResource.getId().getId().toString();
+
+        //create widget type
+        WidgetsBundle widgetsBundle = new WidgetsBundle();
+        widgetsBundle.setTitle("My widgets bundle");
+        WidgetsBundle savedWidgetsBundle = doPost("/api/widgetsBundle", widgetsBundle, WidgetsBundle.class);
+
+        WidgetTypeDetails widgetType = new WidgetTypeDetails();
+        widgetType.setBundleAlias(savedWidgetsBundle.getAlias());
+        widgetType.setName("Widget Type");
+        widgetType.setDescriptor(JacksonUtil.fromString(String.format("{ \"resources\": [{\"url\":{\"entityType\":\"TB_RESOURCE\",\"id\":\"%s\"},\"isModule\":true}]}", savedResource.getId()), JsonNode.class));
+        doPost("/api/widgetType", widgetType, WidgetTypeDetails.class);
+
+        doDelete("/api/resource/" + resourceIdStr)
+                .andExpect(status().isBadRequest())
+                .andExpect(statusReason(containsString("Following widget types uses current resource: ["
+                        + widgetType .getName()+ "]")));
+    }
+
     @Test
     public void testFindTenantTbResources() throws Exception {
 

common/dao-api/src/main/java/org/thingsboard/server/dao/widget/WidgetTypeService.java

@@ -15,6 +15,7 @@
  */
 package org.thingsboard.server.dao.widget;
 
+import org.thingsboard.server.common.data.id.TbResourceId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.id.WidgetTypeId;
 import org.thingsboard.server.common.data.widget.WidgetType;
@@ -40,6 +41,8 @@ public interface WidgetTypeService extends EntityDaoService {
 
     List<WidgetTypeInfo> findWidgetTypesInfosByTenantIdAndBundleAlias(TenantId tenantId, String bundleAlias);
 
+    List<WidgetTypeDetails> findWidgetTypesInfosByTenantIdAndResourceId(TenantId tenantId, TbResourceId tbResourceId);
+
     WidgetType findWidgetTypeByTenantIdBundleAliasAndAlias(TenantId tenantId, String bundleAlias, String alias);
 
     void deleteWidgetTypesByTenantIdAndBundleAlias(TenantId tenantId, String bundleAlias);

dao/src/main/java/org/thingsboard/server/dao/resource/BaseResourceService.java

@@ -109,6 +109,7 @@ public class BaseResourceService extends AbstractCachedEntityService<ResourceInf
     public void deleteResource(TenantId tenantId, TbResourceId resourceId) {
         log.trace("Executing deleteResource [{}] [{}]", tenantId, resourceId);
         Validator.validateId(resourceId, INCORRECT_RESOURCE_ID + resourceId);
+        resourceValidator.validateDelete(tenantId, resourceId);
         resourceDao.removeById(tenantId, resourceId.getId());
     }
 

dao/src/main/java/org/thingsboard/server/dao/service/DataValidator.java

@@ -22,6 +22,7 @@ import org.springframework.context.annotation.Lazy;
 import org.thingsboard.server.common.data.BaseData;
 import org.thingsboard.server.common.data.EntityType;
 import org.thingsboard.server.common.data.StringUtils;
+import org.thingsboard.server.common.data.id.EntityId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.dao.TenantEntityWithDataDao;
 import org.thingsboard.server.dao.exception.DataValidationException;
@@ -82,6 +83,9 @@ public abstract class DataValidator<D extends BaseData<?>> {
         return null;
     }
 
+    public void validateDelete(TenantId tenantId, EntityId entityId) {
+    }
+
     protected boolean isSameData(D existentData, D actualData) {
         return actualData.getId() != null && existentData.getId().equals(actualData.getId());
     }

dao/src/main/java/org/thingsboard/server/dao/service/validator/ResourceDataValidator.java

@@ -20,14 +20,21 @@ import org.springframework.context.annotation.Lazy;
 import org.springframework.stereotype.Component;
 import org.thingsboard.server.common.data.StringUtils;
 import org.thingsboard.server.common.data.TbResource;
+import org.thingsboard.server.common.data.id.EntityId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.tenant.profile.DefaultTenantProfileConfiguration;
+import org.thingsboard.server.common.data.widget.BaseWidgetType;
+import org.thingsboard.server.common.data.widget.WidgetTypeDetails;
 import org.thingsboard.server.dao.exception.DataValidationException;
 import org.thingsboard.server.dao.model.ModelConstants;
 import org.thingsboard.server.dao.resource.TbResourceDao;
 import org.thingsboard.server.dao.service.DataValidator;
 import org.thingsboard.server.dao.tenant.TbTenantProfileCache;
 import org.thingsboard.server.dao.tenant.TenantService;
+import org.thingsboard.server.dao.widget.WidgetTypeDao;
+
+import java.util.List;
+import java.util.stream.Collectors;
 
 import static org.thingsboard.server.common.data.EntityType.TB_RESOURCE;
 
@@ -37,6 +44,9 @@ public class ResourceDataValidator extends DataValidator<TbResource> {
     @Autowired
     private TbResourceDao resourceDao;
 
+    @Autowired
+    private WidgetTypeDao widgetTypeDao;
+
     @Autowired
     private TenantService tenantService;
 
@@ -77,4 +87,15 @@ public class ResourceDataValidator extends DataValidator<TbResource> {
             }
         }
     }
+
+    @Override
+    public void validateDelete(TenantId tenantId, EntityId resourceId) {
+        List<WidgetTypeDetails> widgets = widgetTypeDao.findWidgetTypesInfosByTenantIdAndResourceId(tenantId.getId(),
+                resourceId.getId());
+        if (!widgets.isEmpty()) {
+            List<String> widgetNames = widgets.stream().map(BaseWidgetType::getName).collect(Collectors.toList());
+            throw new DataValidationException(String.format("Following widget types uses current resource: %s", widgetNames));
+        }
+    }
+
 }

dao/src/main/java/org/thingsboard/server/dao/sql/widget/JpaWidgetTypeDao.java

@@ -77,6 +77,11 @@ public class JpaWidgetTypeDao extends JpaAbstractDao<WidgetTypeDetailsEntity, Wi
         return DaoUtil.getData(widgetTypeRepository.findWidgetTypeByTenantIdAndBundleAliasAndAlias(tenantId, bundleAlias, alias));
     }
 
+    @Override
+    public List<WidgetTypeDetails> findWidgetTypesInfosByTenantIdAndResourceId(UUID tenantId, UUID tbResourceId) {
+        return DaoUtil.convertDataList(widgetTypeRepository.findWidgetTypesInfosByTenantIdAndResourceId(tenantId, tbResourceId));
+    }
+
     @Override
     public EntityType getEntityType() {
         return EntityType.WIDGET_TYPE;

dao/src/main/java/org/thingsboard/server/dao/sql/widget/WidgetTypeRepository.java

@@ -46,4 +46,11 @@ public interface WidgetTypeRepository extends JpaRepository<WidgetTypeDetailsEnt
     WidgetTypeEntity findWidgetTypeByTenantIdAndBundleAliasAndAlias(@Param("tenantId") UUID tenantId,
                                                           @Param("bundleAlias") String bundleAlias,
                                                           @Param("alias") String alias);
+
+    @Query(value = "SELECT * FROM widget_type wt " +
+            "WHERE wt.tenant_id = :tenantId AND cast(wt.descriptor as json) ->> 'resources' LIKE LOWER(CONCAT('%', :resourceId, '%'))",
+    nativeQuery = true)
+    List<WidgetTypeDetailsEntity> findWidgetTypesInfosByTenantIdAndResourceId(@Param("tenantId") UUID tenantId,
+                                                                    @Param("resourceId") UUID resourceId);
+
 }

dao/src/main/java/org/thingsboard/server/dao/widget/WidgetTypeDao.java

@@ -83,4 +83,12 @@ public interface WidgetTypeDao extends Dao<WidgetTypeDetails> {
      */
     WidgetType findByTenantIdBundleAliasAndAlias(UUID tenantId, String bundleAlias, String alias);
 
+    /**
+     * Find widget types infos by tenantId and resourceId in descriptor.
+     *
+     * @param tenantId the tenantId
+     * @param tbResourceId the resourceId
+     * @return the list of widget types infos objects
+     */
+    List<WidgetTypeDetails> findWidgetTypesInfosByTenantIdAndResourceId(UUID tenantId, UUID tbResourceId);
 }

dao/src/main/java/org/thingsboard/server/dao/widget/WidgetTypeServiceImpl.java

@@ -21,6 +21,7 @@ import org.springframework.stereotype.Service;
 import org.thingsboard.server.common.data.EntityType;
 import org.thingsboard.server.common.data.id.EntityId;
 import org.thingsboard.server.common.data.id.HasId;
+import org.thingsboard.server.common.data.id.TbResourceId;
 import org.thingsboard.server.common.data.id.TenantId;
 import org.thingsboard.server.common.data.id.WidgetTypeId;
 import org.thingsboard.server.common.data.widget.WidgetType;
@@ -37,6 +38,7 @@ import java.util.Optional;
 public class WidgetTypeServiceImpl implements WidgetTypeService {
 
     public static final String INCORRECT_TENANT_ID = "Incorrect tenantId ";
+    public static final String INCORRECT_RESOURCE_ID = "Incorrect resourceId ";
     public static final String INCORRECT_BUNDLE_ALIAS = "Incorrect bundleAlias ";
     @Autowired
     private WidgetTypeDao widgetTypeDao;
@@ -96,6 +98,14 @@ public class WidgetTypeServiceImpl implements WidgetTypeService {
         return widgetTypeDao.findWidgetTypesInfosByTenantIdAndBundleAlias(tenantId.getId(), bundleAlias);
     }
 
+    @Override
+    public List<WidgetTypeDetails> findWidgetTypesInfosByTenantIdAndResourceId(TenantId tenantId, TbResourceId tbResourceId) {
+        log.trace("Executing findWidgetTypesInfosByTenantIdAndResourceId, tenantId [{}], tbResourceId [{}]", tenantId, tbResourceId);
+        Validator.validateId(tenantId, INCORRECT_TENANT_ID + tenantId);
+        Validator.validateId(tbResourceId, INCORRECT_RESOURCE_ID + tbResourceId);
+        return widgetTypeDao.findWidgetTypesInfosByTenantIdAndResourceId(tenantId.getId(), tbResourceId.getId());
+    }
+
     @Override
     public WidgetType findWidgetTypeByTenantIdBundleAliasAndAlias(TenantId tenantId, String bundleAlias, String alias) {
         log.trace("Executing findWidgetTypeByTenantIdBundleAliasAndAlias, tenantId [{}], bundleAlias [{}], alias [{}]", tenantId, bundleAlias, alias);