fix: delete page revisions when api is deleted

gravitee-io · Oct 29, 2024 · e3e9992 · e3e9992
1 parent 4d98e31
commit e3e9992
Show file tree

Hide file tree

Showing 9 changed files with 80 additions and 0 deletions.
diff --git a/...itory-api/src/main/java/io/gravitee/repository/management/api/PageRevisionRepository.java b/...itory-api/src/main/java/io/gravitee/repository/management/api/PageRevisionRepository.java
@@ -48,4 +48,6 @@ public interface PageRevisionRepository extends FindAllRepository<PageRevision>
     Optional<PageRevision> findLastByPageId(String pageId) throws TechnicalException;
 
     List<String> deleteByPageId(String pageId) throws TechnicalException;
+
+    void deleteAllByPageId(String pageId) throws TechnicalException;
 }
diff --git a/...jdbc/src/main/java/io/gravitee/repository/jdbc/management/JdbcPageRevisionRepository.java b/...jdbc/src/main/java/io/gravitee/repository/jdbc/management/JdbcPageRevisionRepository.java
@@ -156,4 +156,21 @@ public List<String> deleteByPageId(String pageId) throws TechnicalException {
             throw new TechnicalException("Failed to delete page revision by page id", ex);
         }
     }
+
+    @Override
+    public void deleteAllByPageId(String pageId) throws TechnicalException {
+        LOGGER.debug("JdbcPageRevisionRepository.deleteAllByPageId({})", pageId);
+        try {
+            String sql = "DELETE FROM " + this.tableName + " WHERE page_id = ?";
+            int rowsAffected = jdbcTemplate.update(sql, pageId);
+            LOGGER.debug("JdbcPageRevisionRepository.deleteAllByPageId({}) = {} rows deleted", pageId, rowsAffected);
+
+            if (rowsAffected == 0) {
+                LOGGER.warn("No revisions found for page id: {}", pageId);
+            }
+        } catch (final Exception ex) {
+            LOGGER.error("Failed to delete revisions by page id: {}", pageId, ex);
+            throw new TechnicalException("Failed to delete revisions by page id", ex);
+        }
+    }
 }
diff --git a/.../src/main/java/io/gravitee/repository/mongodb/management/MongoPageRevisionRepository.java b/.../src/main/java/io/gravitee/repository/mongodb/management/MongoPageRevisionRepository.java
@@ -103,6 +103,16 @@ public Optional<PageRevision> findLastByPageId(String pageId) throws TechnicalEx
         }
     }
 
+    @Override
+    public void deleteAllByPageId(String pageId) throws TechnicalException {
+        try {
+            internalPageRevisionRepo.deleteAllByPageId(pageId);
+        } catch (Exception e) {
+            logger.error("An error occurred when deleting revision for page [{}]", pageId, e);
+            throw new TechnicalException("An error occurred when deleting the page revisions");
+        }
+    }
+
     @Override
     public Set<PageRevision> findAll() throws TechnicalException {
         return internalPageRevisionRepo

diff --git a/...tee/repository/mongodb/management/internal/page/revision/PageRevisionMongoRepository.java b/...tee/repository/mongodb/management/internal/page/revision/PageRevisionMongoRepository.java
@@ -32,6 +32,9 @@ public interface PageRevisionMongoRepository
     @Query(value = "{ '_id.pageId' : ?0 }", sort = "{ 'revision': 1 }", delete = true)
     List<PageRevisionMongo> deleteByPageId(String pageId);
 
+    @Query(value = "{ '_id.pageId' : ?0 }", delete = true)
+    void deleteAllByPageId(String pageId);
+
     @Query(value = "{ '_id.pageId' : ?0 }", sort = "{ 'revision': 1 }")
     List<PageRevisionMongo> findAllByPageId(String pageId);
 }
diff --git a/...tory-test/src/test/java/io/gravitee/repository/management/PageRevisionRepositoryTest.java b/...tory-test/src/test/java/io/gravitee/repository/management/PageRevisionRepositoryTest.java
@@ -16,6 +16,8 @@
 package io.gravitee.repository.management;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
 
 import io.gravitee.common.data.domain.Page;
 import io.gravitee.repository.exceptions.TechnicalException;
@@ -158,4 +160,26 @@ public void should_delete_by_page_id() throws Exception {
         assertThat(deleted.size()).isEqualTo(2);
         assertThat(nbAfterDeletion).isEqualTo(0);
     }
+
+    @Test
+    public void shouldDeleteAllByPageId() throws TechnicalException {
+        List<PageRevision> revisionsBefore = pageRevisionRepository.findAllByPageId("findByPageId");
+        assertNotNull(revisionsBefore);
+        assertEquals(3, revisionsBefore.size());
+
+        pageRevisionRepository.deleteAllByPageId("findByPageId");
+
+        List<PageRevision> revisionsAfter = pageRevisionRepository.findAllByPageId("findByPageId");
+        assertNotNull(revisionsAfter);
+        assertEquals(0, revisionsAfter.size());
+    }
+
+    @Test
+    public void shouldDoNothingWhenNoRevisionsFoundWhileDeleting() throws TechnicalException {
+        pageRevisionRepository.deleteAllByPageId("nonExistingPageId");
+
+        List<PageRevision> revisionsAfter = pageRevisionRepository.findAllByPageId("nonExistingPageId");
+        assertNotNull(revisionsAfter);
+        assertEquals(0, revisionsAfter.size());
+    }
 }
diff --git a/...apim-rest-api-service/src/main/java/io/gravitee/rest/api/service/PageRevisionService.java b/...apim-rest-api-service/src/main/java/io/gravitee/rest/api/service/PageRevisionService.java
@@ -15,6 +15,7 @@
  */
 package io.gravitee.rest.api.service;
 
+import io.gravitee.repository.exceptions.TechnicalException;
 import io.gravitee.repository.management.api.search.Pageable;
 import io.gravitee.repository.management.model.Page;
 import io.gravitee.rest.api.model.PageRevisionEntity;
@@ -35,4 +36,6 @@ public interface PageRevisionService {
     List<PageRevisionEntity> findAllByPageId(String pageId);
 
     PageRevisionEntity create(Page page);
+
+    void deleteAllByPageId(String pageId) throws TechnicalException;
 }
diff --git a/...-api-service/src/main/java/io/gravitee/rest/api/service/impl/PageRevisionServiceImpl.java b/...-api-service/src/main/java/io/gravitee/rest/api/service/impl/PageRevisionServiceImpl.java
@@ -115,6 +115,11 @@ public PageRevisionEntity create(Page page) {
         }
     }
 
+    @Override
+    public void deleteAllByPageId(String pageId) throws TechnicalException {
+        pageRevisionRepository.deleteAllByPageId(pageId);
+    }
+
     private PageRevisionEntity convert(PageRevision revision) {
         PageRevisionEntity entity = new PageRevisionEntity();
         entity.setPageId(revision.getPageId());

diff --git a/...pim-rest-api-service/src/main/java/io/gravitee/rest/api/service/impl/PageServiceImpl.java b/...pim-rest-api-service/src/main/java/io/gravitee/rest/api/service/impl/PageServiceImpl.java
@@ -2116,6 +2116,9 @@ public void delete(ExecutionContext executionContext, String pageId) {
 
             pageRepository.delete(pageId);
 
+            // delete page revisions
+            pageRevisionService.deleteAllByPageId(pageId);
+
             // delete links and translations related to the page
             if (!PageType.LINK.name().equalsIgnoreCase(page.getType()) && !PageType.TRANSLATION.name().equalsIgnoreCase(page.getType())) {
                 this.deleteRelatedPages(page.getId());

diff --git a/...-api-service/src/test/java/io/gravitee/rest/api/service/impl/PageRevisionServiceTest.java b/...-api-service/src/test/java/io/gravitee/rest/api/service/impl/PageRevisionServiceTest.java
@@ -26,6 +26,7 @@
 import io.gravitee.rest.api.model.PageRevisionEntity;
 import io.gravitee.rest.api.model.PageType;
 import io.gravitee.rest.api.service.AuditService;
+import io.gravitee.rest.api.service.common.GraviteeContext;
 import io.gravitee.rest.api.service.exceptions.TechnicalManagementException;
 import io.gravitee.rest.api.service.impl.PageRevisionServiceImpl;
 import java.util.Date;
@@ -149,4 +150,16 @@ public void shouldNotCreate_Because_InvalidType() throws TechnicalException {
         when(page.getType()).thenReturn(PageType.FOLDER.name());
         pageRevisionService.create(page);
     }
+
+    @Test
+    public void shouldDeletePageRevision() throws TechnicalException {
+        pageRevisionService.deleteAllByPageId(PAGE_ID);
+        verify(pageRevisionRepository).deleteAllByPageId(PAGE_ID);
+    }
+
+    @Test(expected = TechnicalException.class)
+    public void shouldNotDeletePageRevisionBecauseTechnicalException() throws TechnicalException {
+        doThrow(TechnicalException.class).when(pageRevisionRepository).deleteAllByPageId(PAGE_ID);
+        pageRevisionService.deleteAllByPageId(PAGE_ID);
+    }
 }