Merge pull request #18 from commonground-project/feat/add-viewpoint-api

Add Viewpoint api
commonground-project · Dec 3, 2024 · 6d5ca69 · 6d5ca69
2 parents 93c2e15 + 6828f5c
commit 6d5ca69
Show file tree

Hide file tree

Showing 50 changed files with 1,257 additions and 131 deletions.
diff --git a/src/main/java/tw/commonground/backend/exception/GlobalExceptionHandler.java b/src/main/java/tw/commonground/backend/exception/GlobalExceptionHandler.java
@@ -10,6 +10,7 @@
 import org.springframework.web.HttpRequestMethodNotSupportedException;
 import org.springframework.web.bind.MethodArgumentNotValidException;
 import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.context.request.WebRequest;
 import org.springframework.web.method.annotation.HandlerMethodValidationException;
 import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
@@ -91,6 +92,14 @@ protected ResponseEntity<Object> handleHandlerMethodValidationException(HandlerM
         return super.handleExceptionInternal(exception, null, headers, status, request);
     }
 
+    @ExceptionHandler(IllegalArgumentException.class)
+    protected ResponseEntity<Object> handleIllegalArgumentException(IllegalArgumentException ex, WebRequest request) {
+        ErrorResponseException exception = createValidException();
+        exception.setDetail(ex.getMessage());
+
+        return super.handleExceptionInternal(exception, null, new HttpHeaders(), HttpStatus.BAD_REQUEST, request);
+    }
+
     private ErrorResponseException createValidException() {
         ErrorResponseException exception = new ErrorResponseException(HttpStatus.BAD_REQUEST);
         exception.setTitle("Validation error");

diff --git a/src/main/java/tw/commonground/backend/pagination/PaginationValidator.java b/src/main/java/tw/commonground/backend/pagination/PaginationValidator.java
diff --git a/src/main/java/tw/commonground/backend/pagination/package-info.java b/src/main/java/tw/commonground/backend/pagination/package-info.java
diff --git a/src/main/java/tw/commonground/backend/service/fact/FactController.java b/src/main/java/tw/commonground/backend/service/fact/FactController.java
@@ -7,11 +7,11 @@
 import org.springframework.web.bind.annotation.*;
 import tw.commonground.backend.service.fact.dto.FactRequest;
 import tw.commonground.backend.service.fact.dto.FactResponse;
-import tw.commonground.backend.pagination.PaginationValidator;
+import tw.commonground.backend.shared.pagination.PaginationParser;
 import tw.commonground.backend.service.reference.ReferenceRequest;
 import tw.commonground.backend.service.reference.ReferenceResponse;
-import tw.commonground.backend.pagination.PaginationRequest;
-import tw.commonground.backend.pagination.WrappedPaginationResponse;
+import tw.commonground.backend.shared.pagination.PaginationRequest;
+import tw.commonground.backend.shared.pagination.WrappedPaginationResponse;
 
 import java.util.*;
 
@@ -23,15 +23,15 @@ public class FactController {
 
     private final Set<String> sortableColumn = Set.of("title", "createAt", "updateAt", "authorId", "authorName");
 
-    private final PaginationValidator paginationValidator = new PaginationValidator(sortableColumn, MAX_SIZE);
+    private final PaginationParser paginationParser = new PaginationParser(sortableColumn, MAX_SIZE);
 
     public FactController(FactService factService) {
         this.factService = factService;
     }
 
     @GetMapping("/api/facts")
     public WrappedPaginationResponse<List<FactResponse>> listFacts(@Valid PaginationRequest pagination) {
-        Pageable pageable = paginationValidator.validatePaginationRequest(pagination);
+        Pageable pageable = paginationParser.parsePageable(pagination);
         return factService.getFacts(pageable);
     }
 

diff --git a/src/main/java/tw/commonground/backend/service/fact/FactService.java b/src/main/java/tw/commonground/backend/service/fact/FactService.java
@@ -13,8 +13,8 @@
 import tw.commonground.backend.service.fact.entity.FactEntity;
 import tw.commonground.backend.service.fact.entity.FactRepository;
 import tw.commonground.backend.service.reference.*;
-import tw.commonground.backend.pagination.PaginationMapper;
-import tw.commonground.backend.pagination.WrappedPaginationResponse;
+import tw.commonground.backend.shared.pagination.PaginationMapper;
+import tw.commonground.backend.shared.pagination.WrappedPaginationResponse;
 
 import java.net.URL;
 import java.net.URLDecoder;
@@ -131,6 +131,16 @@ public void deleteFactReferences(UUID id, UUID referenceId) {
         factRepository.save(factEntity);
     }
 
+    public void throwIfFactsNotExist(List<UUID> factIds) {
+        List<UUID> existingFactIds = factRepository.findExistingIdsByIds(factIds);
+        List<UUID> missingFacts = factIds.stream()
+                .filter(factId -> !existingFactIds.contains(factId))
+                .toList();
+        if (!missingFacts.isEmpty()) {
+            throw new EntityNotFoundException("Fact", "ids", missingFacts.toString());
+        }
+    }
+
     private Set<ReferenceEntity> parseReferenceEntity(List<String> urls) {
         urls = urlHandling(urls);
 

diff --git a/src/main/java/tw/commonground/backend/service/fact/dto/FactMapper.java b/src/main/java/tw/commonground/backend/service/fact/dto/FactMapper.java
@@ -3,6 +3,11 @@
 import tw.commonground.backend.service.fact.entity.FactEntity;
 import tw.commonground.backend.service.reference.ReferenceMapper;
 
+import java.util.Collection;
+import java.util.Set;
+import java.util.UUID;
+import java.util.stream.Collectors;
+
 public final class FactMapper {
 
     private FactMapper() {
@@ -21,4 +26,9 @@ public static FactResponse toResponse(FactEntity factEntity) {
                 .build();
     }
 
+    public static Set<FactEntity> toEntities(Collection<UUID> factIds) {
+        return factIds.stream()
+                .map(factId -> FactEntity.builder().id(factId).build())
+                .collect(Collectors.toSet());
+    }
 }
diff --git a/src/main/java/tw/commonground/backend/service/fact/entity/FactRepository.java b/src/main/java/tw/commonground/backend/service/fact/entity/FactRepository.java
@@ -1,8 +1,13 @@
 package tw.commonground.backend.service.fact.entity;
 
 import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Query;
+import org.springframework.data.repository.query.Param;
 
+import java.util.List;
 import java.util.UUID;
 
 public interface FactRepository extends JpaRepository<FactEntity, UUID> {
+    @Query("SELECT f.id FROM FactEntity f WHERE f.id IN :ids")
+    List<UUID> findExistingIdsByIds(@Param("ids") List<UUID> ids);
 }
diff --git a/src/main/java/tw/commonground/backend/service/issue/IssueController.java b/src/main/java/tw/commonground/backend/service/issue/IssueController.java
@@ -14,36 +14,37 @@
 import tw.commonground.backend.service.issue.dto.IssueResponse;
 import tw.commonground.backend.service.issue.dto.SimpleIssueResponse;
 import tw.commonground.backend.service.issue.entity.IssueEntity;
-import tw.commonground.backend.pagination.PaginationMapper;
-import tw.commonground.backend.pagination.PaginationRequest;
-import tw.commonground.backend.pagination.PaginationValidator;
-import tw.commonground.backend.pagination.WrappedPaginationResponse;
+import tw.commonground.backend.shared.pagination.PaginationMapper;
+import tw.commonground.backend.shared.pagination.PaginationRequest;
+import tw.commonground.backend.shared.pagination.PaginationParser;
+import tw.commonground.backend.shared.pagination.WrappedPaginationResponse;
 import tw.commonground.backend.service.issue.entity.SimpleIssueEntity;
-import tw.commonground.backend.service.issue.insight.Insight;
-import tw.commonground.backend.service.issue.insight.InsightParser;
+import tw.commonground.backend.shared.content.ContentContainFact;
+import tw.commonground.backend.shared.content.ContentContainFactParser;
 
 import java.util.*;
 
 @RestController
+@RequestMapping("/api")
 public class IssueController {
     private static final int MAX_SIZE = 200;
 
     private final IssueService issueService;
 
     private final FactService factService;
 
-    private final Set<String> sortableColumn = Set.of("title", "createAt", "updateAt", "authorId", "authorName");
+    private final Set<String> sortableColumn = Set.of("title", "createdAt", "updatedAt");
 
-    private final PaginationValidator paginationValidator = new PaginationValidator(sortableColumn, MAX_SIZE);
+    private final PaginationParser paginationParser = new PaginationParser(sortableColumn, MAX_SIZE);
 
     public IssueController(IssueService issueService, FactService factService) {
         this.issueService = issueService;
         this.factService = factService;
     }
 
-    @GetMapping("/api/issues")
+    @GetMapping("/issues")
     public WrappedPaginationResponse<List<SimpleIssueResponse>> listIssues(@Valid PaginationRequest pagination) {
-        Pageable pageable = paginationValidator.validatePaginationRequest(pagination);
+        Pageable pageable = paginationParser.parsePageable(pagination);
         Page<SimpleIssueEntity> pageIssues = issueService.getIssues(pageable);
 
         List<SimpleIssueResponse> issueResponses = pageIssues.getContent()
@@ -54,43 +55,46 @@ public WrappedPaginationResponse<List<SimpleIssueResponse>> listIssues(@Valid Pa
         return new WrappedPaginationResponse<>(issueResponses, PaginationMapper.toResponse(pageIssues));
     }
 
-    @PostMapping("/api/issues")
+    @PostMapping("/issues")
     public IssueResponse createIssue(@Valid @RequestBody IssueRequest issueRequest) {
         IssueEntity issueEntity = issueService.createIssue(issueRequest);
-        Insight insight = InsightParser.separateInsightAndFacts(issueEntity.getInsight());
+        ContentContainFact contentContainFact = ContentContainFactParser
+                .separateContentAndFacts(issueEntity.getInsight());
 
-        List<FactEntity> factResponses = factService.getFacts(insight.getFacts());
+        List<FactEntity> factResponses = factService.getFacts(contentContainFact.getFacts());
         return IssueMapper.toResponse(issueEntity, factResponses);
     }
 
-    @GetMapping("/api/issue/{id}")
+    @GetMapping("/issue/{id}")
     public IssueResponse getIssue(@PathVariable UUID id) {
         IssueEntity issueEntity = issueService.getIssue(id);
-        Insight insight = InsightParser.separateInsightAndFacts(issueEntity.getInsight());
+        ContentContainFact contentContainFact = ContentContainFactParser
+                .separateContentAndFacts(issueEntity.getInsight());
 
-        List<FactEntity> factResponses = factService.getFacts(insight.getFacts());
+        List<FactEntity> factResponses = factService.getFacts(contentContainFact.getFacts());
         return IssueMapper.toResponse(issueEntity, factResponses);
     }
 
-    @PutMapping("/api/issue/{id}")
+    @PutMapping("/issue/{id}")
     public IssueResponse updateIssue(@PathVariable UUID id, @Valid @RequestBody IssueRequest issueRequest) {
         IssueEntity issueEntity = issueService.updateIssue(id, issueRequest);
-        Insight insight = InsightParser.separateInsightAndFacts(issueEntity.getInsight());
+        ContentContainFact contentContainFact = ContentContainFactParser
+                .separateContentAndFacts(issueEntity.getInsight());
 
-        List<FactEntity> factResponses = factService.getFacts(insight.getFacts());
+        List<FactEntity> factResponses = factService.getFacts(contentContainFact.getFacts());
         return IssueMapper.toResponse(issueEntity, factResponses);
     }
 
-    @DeleteMapping("/api/issue/{id}")
+    @DeleteMapping("/issue/{id}")
     public void deleteIssue(@PathVariable String id) {
         issueService.deleteIssue(UUID.fromString(id));
     }
 
-    @GetMapping("/api/issue/{id}/facts")
+    @GetMapping("/issue/{id}/facts")
     public WrappedPaginationResponse<List<FactResponse>> getIssueFacts(@PathVariable UUID id,
                                                                        @Valid PaginationRequest pagination) {
-        PaginationValidator validator = new PaginationValidator(Collections.emptySet(), MAX_SIZE);
-        Pageable pageable = validator.validatePaginationRequest(pagination);
+        PaginationParser validator = new PaginationParser(Collections.emptySet(), MAX_SIZE);
+        Pageable pageable = validator.parsePageable(pagination);
         Page<FactEntity> pageFacts = issueService.getIssueFacts(id, pageable);
 
         List<FactResponse> factResponses = pageFacts.getContent()
@@ -101,7 +105,7 @@ public WrappedPaginationResponse<List<FactResponse>> getIssueFacts(@PathVariable
         return new WrappedPaginationResponse<>(factResponses, PaginationMapper.toResponse(pageFacts));
     }
 
-    @PostMapping("/api/issue/{id}/facts")
+    @PostMapping("/issue/{id}/facts")
     public Map<String, List<FactResponse>> linkFactsToIssue(@PathVariable UUID id,
                                                             @Valid @RequestBody LinkFactsRequest request) {
         List<FactEntity> factEntities = issueService.createManualFact(id, request.getFactIds());