Skip to content

API / Feedback improvements #9451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fxprunayre wants to merge 3 commits into
base: main
Choose a base branch
from
Open

API / Feedback improvements #9451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b32975
API / Feedback improvements
fxprunayre Jul 29, 2026
4032469
Apply suggestions from code review
fxprunayre Aug 7, 2026
5e810fa
Apply review suggestions.
fxprunayre Aug 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions domain/src/main/java/org/fao/geonet/repository/userfeedback/UserFeedbackRepository.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,14 @@ public interface UserFeedbackRepository extends JpaRepository<UserFeedback, UUID
*/
List<UserFeedback> findByMetadata_UuidAndStatusOrderByCreationDateDesc(String metadataUuid, UserRatingStatus status, Pageable p);

/**
* Find child feedback entries for a parent feedback uuid.
*
* @param parentUuid the parent feedback uuid
* @return the list
*/
List<UserFeedback> findByParent_Uuid(String parentUuid);

/**
* Find by metadata uuid order by date desc.
*
Expand Down
40 changes: 7 additions & 33 deletions services/src/main/java/org/fao/geonet/api/userfeedback/UserFeedbackAPI.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,20 +209,14 @@ public RatingAverage getMetadataRating(
try {
Log.debug("org.fao.geonet.api.userfeedback.UserFeedback", "getMetadataUserComments");

// Check permission for metadata
final AbstractMetadata metadata = ApiUtils.canViewRecord(metadataUuid, request);
if (metadata == null) {
printOutputMessage(response, HttpStatus.FORBIDDEN, ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW);
return null;
}

ApiUtils.canViewRecord(metadataUuid, request);
final UserSession session = ApiUtils.getUserSession(httpSession);

boolean published = true; // Takes only published comments

// showing not published comments only to logged users (maybe better
// restrict to Reviewers)
if (session != null && session.isAuthenticated()) {
if (session.isAuthenticated()) {
published = false;
}

Expand Down Expand Up @@ -280,7 +274,7 @@ public UserFeedbackDTO getUserComment(

// showing not published comments only to logged users (maybe better
// restrict to Reviewers)
if (session != null && session.isAuthenticated()) {
if (session.isAuthenticated()) {
published = false;
}

Expand All @@ -293,11 +287,7 @@ public UserFeedbackDTO getUserComment(
}

// Check permission for metadata
final AbstractMetadata metadata = ApiUtils.canViewRecord(userfeedback.getMetadata().getUuid(), request);
if (metadata == null) {
printOutputMessage(response, HttpStatus.FORBIDDEN, ApiParams.API_RESPONSE_NOT_ALLOWED_CAN_VIEW);
return null;
}
ApiUtils.canViewRecord(userfeedback.getMetadata().getUuid(), request);

return dto;
}
Expand Down Expand Up @@ -408,13 +398,13 @@ private List<UserFeedbackDTO> getUserFeedback(

// showing not published comments only to logged users (maybe better
// restrict to Reviewers)
if (session != null && session.isAuthenticated()) {
if (session.isAuthenticated()) {
published = false;
}

List<UserFeedback> listUserfeedback = null;

if (metadataUuid == null || metadataUuid.equals("")) {
if (metadataUuid == null || metadataUuid.isEmpty()) {
listUserfeedback = userFeedbackService.retrieveUserFeedback(size, published);
} else {
listUserfeedback = userFeedbackService.retrieveUserFeedbackForMetadata(metadataUuid, size, published);
Expand Down Expand Up @@ -522,7 +512,7 @@ public ResponseEntity newUserFeedback(
String catalogueName = settingManager.getValue(SYSTEM_SITE_NAME_PATH);
String title = XslUtil.getIndexField(null, userFeedbackDto.getMetadataUUID(), "resourceTitleObject", "");

if (toAddress.size() > 0) {
if (!toAddress.isEmpty()) {
try {
Locale[] feedbackLocales = feedbackLanguages.getLocales(locale);

Expand Down Expand Up @@ -710,22 +700,6 @@ public ResponseEntity<String> sendEmailToContact(
return new ResponseEntity<>(HttpStatus.CREATED);
}

/**
* Prints the output message.
*
* @param response the response
* @param code the code
* @param message the message
* @throws IOException Signals that an I/O exception has occurred.
*/
private void printOutputMessage(final HttpServletResponse response, final HttpStatus code, final String message) throws IOException {
response.setStatus(code.value());
final PrintWriter out = response.getWriter();
response.setContentType("text/html");
out.println(message);
response.flushBuffer();
}

/**
* Publish.
*
Expand Down
12 changes: 7 additions & 5 deletions services/src/main/java/org/fao/geonet/api/userfeedback/UserFeedbackUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ public RatingAverage getAverage(List<UserFeedback> list) {
ISODate maxDate = null; // LAST COMMENT DATE
RatingAverage v = null;

if (list.size() > 0) {
if (!list.isEmpty()) {
Map<Integer, Integer> ratingAverages = new HashMap<>();
RatingCriteriaRepository criteriaRepository = ApplicationContextHolder.get().getBean(RatingCriteriaRepository.class);
List<RatingCriteria> criteriaList = criteriaRepository.findAll();
Expand All @@ -231,7 +231,7 @@ public RatingAverage getAverage(List<UserFeedback> list) {
maxDate = new ISODate(userFeedback.getCreationDate().getTime());
}

if (userFeedback.getDetailedRatingList() != null && userFeedback.getDetailedRatingList().size() > 0) {
if (userFeedback.getDetailedRatingList() != null && !userFeedback.getDetailedRatingList().isEmpty()) {

for (final Rating rating : userFeedback.getDetailedRatingList()) {
Integer criteriaId = rating.getCategory().getId();
Expand All @@ -242,9 +242,10 @@ public RatingAverage getAverage(List<UserFeedback> list) {
ratingAverages.get(criteriaId) == null
? value
: (ratingAverages.get(criteriaId) + value) / 2);
}
if (criteriaId.equals(AVERAGE_ID)) {
ratingCount++;

if (criteriaId.equals(AVERAGE_ID)) {
ratingCount++;
}
}
}

Expand Down Expand Up @@ -288,6 +289,7 @@ public class RatingAverage {
* @param ratingAverages the average for all rating categories
* @param userfeedbackCount the userfeedback count
* @param lastComment the last comment
* @param ratingCount the rating count
*/
public RatingAverage(Map<Integer, Integer> ratingAverages, int userfeedbackCount, String lastComment, int ratingCount) {
this.ratingAverages = ratingAverages;
Expand Down
16 changes: 14 additions & 2 deletions ...es/src/main/java/org/fao/geonet/api/userfeedback/service/UserFeedbackDatabaseService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import java.util.List;

Expand Down Expand Up @@ -94,23 +95,34 @@
* removeUserFeedback(java.lang.String)
*/
@Override
@Transactional
public void removeUserFeedback(String feedbackUuid, String ip) throws Exception {

Check failure on line 99 in services/src/main/java/org/fao/geonet/api/userfeedback/service/UserFeedbackDatabaseService.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

Specify rollback behavior for checked exceptions using "rollbackFor" or "noRollbackFor" attributes. 


See more on https://sonarcloud.io/project/issues?id=geonetwork_core-geonetwork&issues=AZ-tmX8H-xBUb0ex0nO-&open=AZ-tmX8H-xBUb0ex0nO-&pullRequest=9451
final UserFeedback userFeedback = userFeedbackRepository.findByUuid(feedbackUuid);
final Metadata metadata = userFeedback.getMetadata();

userFeedbackRepository.delete(userFeedback);
deleteUserFeedbackWithChildren(userFeedback);

// Then update global metadata rating
List<UserFeedback> listFeedbacks = retrieveUserFeedbackForMetadata(metadata.getUuid(), -1, true);
Integer average = 0;
if (listFeedbacks.size() > 0) {
if (!listFeedbacks.isEmpty()) {
UserFeedbackUtils.RatingAverage averageRating = new UserFeedbackUtils()
.getAverage(listFeedbacks);
average = averageRating.getRatingAverages().get(AVERAGE_ID);
}
dataManager.rateMetadata(metadata.getId(), ip, average);
}

private void deleteUserFeedbackWithChildren(UserFeedback userFeedback) {
List<UserFeedback> childFeedbacks = userFeedbackRepository.findByParent_Uuid(userFeedback.getUuid());

for (UserFeedback childFeedback : childFeedbacks) {
deleteUserFeedbackWithChildren(childFeedback);
}

userFeedbackRepository.delete(userFeedback);
}

/*
* (non-Javadoc)
*
Expand Down
113 changes: 113 additions & 0 deletions ...rc/test/java/org/fao/geonet/api/userfeedback/service/UserFeedbackDatabaseServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
/*
* Copyright (C) 2001-2026 Food and Agriculture Organization of the
* United Nations (FAO-UN), United Nations World Food Programme (WFP)
* and United Nations Environment Programme (UNEP)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
*
* Contact: Jeroen Ticheler - FAO - Viale delle Terme di Caracalla 2,
* Rome - Italy. email: geonetwork@osgeo.org
*/
package org.fao.geonet.api.userfeedback.service;

import org.fao.geonet.domain.Metadata;
import org.fao.geonet.domain.userfeedback.UserFeedback;
import org.fao.geonet.domain.userfeedback.UserFeedback.UserRatingStatus;
import org.fao.geonet.kernel.datamanager.IMetadataUtils;
import org.fao.geonet.repository.MetadataRepository;
import org.fao.geonet.repository.UserRepository;
import org.fao.geonet.repository.userfeedback.RatingRepository;
import org.fao.geonet.repository.userfeedback.UserFeedbackRepository;
import org.junit.Before;
import org.junit.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;

import java.util.Collections;

import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.isNull;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

public class UserFeedbackDatabaseServiceTest {

@Mock
private IMetadataUtils dataManager;

@Mock
private MetadataRepository metadataRepository;

@Mock
private RatingRepository ratingRepository;

@Mock
private UserFeedbackRepository userFeedbackRepository;

@Mock
private UserRepository userRepository;

@InjectMocks
private UserFeedbackDatabaseService service;

@Before
public void setUp() {
MockitoAnnotations.initMocks(this);
}

@Test
public void removeUserFeedbackDeletesChildrenBeforeParent() throws Exception {
Metadata metadata = new Metadata();
metadata.setId(12);
metadata.setUuid("metadata-uuid");

UserFeedback parent = new UserFeedback();
parent.setUuid("parent");
parent.setMetadata(metadata);

UserFeedback child = new UserFeedback();
child.setUuid("child");
child.setMetadata(metadata);

UserFeedback grandChild = new UserFeedback();
grandChild.setUuid("grand-child");
grandChild.setMetadata(metadata);

when(userFeedbackRepository.findByUuid("parent")).thenReturn(parent);
when(userFeedbackRepository.findByParent_Uuid("parent")).thenReturn(Collections.singletonList(child));
when(userFeedbackRepository.findByParent_Uuid("child")).thenReturn(Collections.singletonList(grandChild));
when(userFeedbackRepository.findByParent_Uuid("grand-child")).thenReturn(Collections.emptyList());
when(userFeedbackRepository.findByMetadata_UuidAndStatusOrderByCreationDateDesc(
eq("metadata-uuid"), eq(UserRatingStatus.PUBLISHED), isNull()))
.thenReturn(Collections.emptyList());

service.removeUserFeedback("parent", "127.0.0.1");

org.mockito.InOrder inOrder = inOrder(userFeedbackRepository);
inOrder.verify(userFeedbackRepository).findByUuid("parent");
inOrder.verify(userFeedbackRepository).findByParent_Uuid("parent");
inOrder.verify(userFeedbackRepository).findByParent_Uuid("child");
inOrder.verify(userFeedbackRepository).findByParent_Uuid("grand-child");
inOrder.verify(userFeedbackRepository).delete(grandChild);
inOrder.verify(userFeedbackRepository).delete(child);
inOrder.verify(userFeedbackRepository).delete(parent);
inOrder.verify(userFeedbackRepository).findByMetadata_UuidAndStatusOrderByCreationDateDesc(
"metadata-uuid", UserRatingStatus.PUBLISHED, null);

verify(dataManager).rateMetadata(12, "127.0.0.1", 0);
}
}
Loading