RED-8174: Fixed transaction handling for notification preferences

This commit is contained in:
Dominique Eifländer 2024-01-09 10:38:09 +01:00
parent be705a5406
commit cf4a650fb5
6 changed files with 81 additions and 72 deletions

View File

@ -9,6 +9,7 @@ import org.springframework.transaction.annotation.Transactional;
import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController; import org.springframework.web.bind.annotation.RestController;
import com.iqser.red.service.persistence.management.v1.processor.service.NotificationPreferencesService;
import com.knecon.fforesight.keycloakcommons.security.KeycloakSecurity; import com.knecon.fforesight.keycloakcommons.security.KeycloakSecurity;
import com.iqser.red.service.persistence.management.v1.processor.service.persistence.NotificationPreferencesPersistenceService; import com.iqser.red.service.persistence.management.v1.processor.service.persistence.NotificationPreferencesPersistenceService;
import com.knecon.fforesight.databasetenantcommons.providers.utils.MagicConverter; import com.knecon.fforesight.databasetenantcommons.providers.utils.MagicConverter;
@ -21,13 +22,14 @@ import lombok.RequiredArgsConstructor;
@RequiredArgsConstructor @RequiredArgsConstructor
public class NotificationPreferencesController implements NotificationPreferencesResource { public class NotificationPreferencesController implements NotificationPreferencesResource {
private final NotificationPreferencesService notificationPreferencesService;
private final NotificationPreferencesPersistenceService notificationPreferencesPersistenceService; private final NotificationPreferencesPersistenceService notificationPreferencesPersistenceService;
@Override @Override
@PreAuthorize("hasAuthority('" + READ_NOTIFICATIONS + "')") @PreAuthorize("hasAuthority('" + READ_NOTIFICATIONS + "')")
public NotificationPreferences getNotificationPreferences() { public NotificationPreferences getNotificationPreferences() {
return notificationPreferencesPersistenceService.getOrCreateNotificationPreferences(KeycloakSecurity.getUserId()); return notificationPreferencesService.getOrCreateNotificationPreferences(KeycloakSecurity.getUserId());
} }

View File

@ -0,0 +1,39 @@
package com.iqser.red.service.persistence.management.v1.processor.service;
import org.springframework.dao.DataIntegrityViolationException;
import org.springframework.stereotype.Service;
import com.iqser.red.service.persistence.management.v1.processor.service.persistence.NotificationPreferencesPersistenceService;
import com.iqser.red.service.persistence.service.v1.api.shared.model.notification.NotificationPreferences;
import lombok.AccessLevel;
import lombok.RequiredArgsConstructor;
import lombok.experimental.FieldDefaults;
import lombok.extern.slf4j.Slf4j;
@Slf4j
@Service
@RequiredArgsConstructor
@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)
public class NotificationPreferencesService {
NotificationPreferencesPersistenceService notificationPreferencesPersistenceService;
public NotificationPreferences getOrCreateNotificationPreferences(String userId) {
var notificationPreferences = notificationPreferencesPersistenceService.getByUserId(userId);
if (notificationPreferences != null){
return notificationPreferences;
}
try {
notificationPreferencesPersistenceService.createNotificationPreferences(userId);
} catch (DataIntegrityViolationException ex) {
log.debug("NotificationPreferences might be already created by another Thread, ignoring...", ex);
}
return notificationPreferencesPersistenceService.getByUserId(userId);
}
}

View File

@ -4,17 +4,17 @@ import java.time.OffsetDateTime;
import java.time.temporal.ChronoUnit; import java.time.temporal.ChronoUnit;
import java.util.List; import java.util.List;
import jakarta.transaction.Transactional;
import org.springframework.beans.BeanUtils; import org.springframework.beans.BeanUtils;
import org.springframework.stereotype.Service; import org.springframework.stereotype.Service;
import com.iqser.red.service.persistence.management.v1.processor.entity.notification.NotificationEntity; import com.iqser.red.service.persistence.management.v1.processor.entity.notification.NotificationEntity;
import com.iqser.red.service.persistence.management.v1.processor.exception.NotFoundException; import com.iqser.red.service.persistence.management.v1.processor.exception.NotFoundException;
import com.iqser.red.service.persistence.management.v1.processor.service.NotificationPreferencesService;
import com.iqser.red.service.persistence.management.v1.processor.service.persistence.repository.NotificationRepository; import com.iqser.red.service.persistence.management.v1.processor.service.persistence.repository.NotificationRepository;
import com.iqser.red.service.persistence.service.v1.api.shared.model.audit.AddNotificationRequest; import com.iqser.red.service.persistence.service.v1.api.shared.model.audit.AddNotificationRequest;
import com.iqser.red.service.persistence.service.v1.api.shared.model.notification.EmailNotificationType; import com.iqser.red.service.persistence.service.v1.api.shared.model.notification.EmailNotificationType;
import jakarta.transaction.Transactional;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import lombok.SneakyThrows; import lombok.SneakyThrows;
@ -24,14 +24,14 @@ public class NotificationPersistenceService {
private final NotificationRepository notificationRepository; private final NotificationRepository notificationRepository;
private final NotificationPreferencesPersistenceService notificationPreferencesPersistenceService; private final NotificationPreferencesService notificationPreferencesService;
private final NotificationEmailService notificationEmailService; private final NotificationEmailService notificationEmailService;
public boolean hasNewNotificationsSince(String userId, OffsetDateTime since) { public boolean hasNewNotificationsSince(String userId, OffsetDateTime since) {
notificationPreferencesPersistenceService.initializePreferencesIfNotExists(userId); notificationPreferencesService.getOrCreateNotificationPreferences(userId);
return notificationRepository.hasInAppNotificationForUser(userId, since.truncatedTo(ChronoUnit.MILLIS)) > 0; return notificationRepository.hasInAppNotificationForUser(userId, since.truncatedTo(ChronoUnit.MILLIS)) > 0;
} }
@ -44,7 +44,7 @@ public class NotificationPersistenceService {
BeanUtils.copyProperties(addNotificationRequest, notification); BeanUtils.copyProperties(addNotificationRequest, notification);
notification.setCreationDate(OffsetDateTime.now()); notification.setCreationDate(OffsetDateTime.now());
var notificationPreferences = notificationPreferencesPersistenceService.getOrCreateNotificationPreferences(addNotificationRequest.getUserId()); var notificationPreferences = notificationPreferencesService.getOrCreateNotificationPreferences(addNotificationRequest.getUserId());
if (!notificationPreferences.isInAppNotificationsEnabled() || !notificationPreferences.getInAppNotifications().contains(notification.getNotificationType())) { if (!notificationPreferences.isInAppNotificationsEnabled() || !notificationPreferences.getInAppNotifications().contains(notification.getNotificationType())) {
notification.setSoftDeleted(OffsetDateTime.now().truncatedTo(ChronoUnit.MILLIS)); notification.setSoftDeleted(OffsetDateTime.now().truncatedTo(ChronoUnit.MILLIS));
} }
@ -103,7 +103,7 @@ public class NotificationPersistenceService {
public List<NotificationEntity> getNotifications(String userId, boolean includeSeen) { public List<NotificationEntity> getNotifications(String userId, boolean includeSeen) {
notificationPreferencesPersistenceService.initializePreferencesIfNotExists(userId); notificationPreferencesService.getOrCreateNotificationPreferences(userId);
if (includeSeen) { if (includeSeen) {
return notificationRepository.findAppNotificationsForUser(userId); return notificationRepository.findAppNotificationsForUser(userId);
} else { } else {

View File

@ -5,6 +5,7 @@ import java.time.temporal.ChronoUnit;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
import java.util.List; import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors; import java.util.stream.Collectors;
import jakarta.transaction.Transactional; import jakarta.transaction.Transactional;
@ -15,6 +16,7 @@ import org.springframework.stereotype.Component;
import org.springframework.stereotype.Service; import org.springframework.stereotype.Service;
import com.iqser.red.service.persistence.management.v1.processor.entity.notification.NotificationPreferencesEntity; import com.iqser.red.service.persistence.management.v1.processor.entity.notification.NotificationPreferencesEntity;
import com.iqser.red.service.persistence.management.v1.processor.exception.NotFoundException;
import com.iqser.red.service.persistence.management.v1.processor.service.persistence.repository.NotificationPreferencesRepository; import com.iqser.red.service.persistence.management.v1.processor.service.persistence.repository.NotificationPreferencesRepository;
import com.iqser.red.service.persistence.management.v1.processor.service.persistence.repository.NotificationRepository; import com.iqser.red.service.persistence.management.v1.processor.service.persistence.repository.NotificationRepository;
import com.knecon.fforesight.databasetenantcommons.providers.utils.MagicConverter; import com.knecon.fforesight.databasetenantcommons.providers.utils.MagicConverter;
@ -32,11 +34,29 @@ public class NotificationPreferencesPersistenceService {
NotificationPreferencesRepository notificationPreferencesRepository; NotificationPreferencesRepository notificationPreferencesRepository;
NonThreadSafeNotificationPreferencesRepositoryWrapper notificationPreferencesRepositoryWrapper;
NotificationRepository notificationRepository; NotificationRepository notificationRepository;
@Transactional
public void createNotificationPreferences(String userId) {
var notificationPreference = new NotificationPreferencesEntity();
notificationPreference.setUserId(userId);
notificationPreference.setEmailNotificationsEnabled(false);
notificationPreference.setInAppNotificationsEnabled(true);
notificationPreference.setInAppNotifications(Arrays.stream(NotificationType.values()).map(Enum::name).collect(Collectors.toList()));
notificationPreferencesRepository.save(notificationPreference);
}
@Transactional
public NotificationPreferences getByUserId(String userId){
var notificationPreferencesEntityOptional = notificationPreferencesRepository.findByUserId(userId);
return notificationPreferencesEntityOptional.map(this::convertPreferences).orElse(null);
}
@Transactional @Transactional
public void setNotificationPreference(String userId, NotificationPreferences newNotificationPreferences) { public void setNotificationPreference(String userId, NotificationPreferences newNotificationPreferences) {
@ -72,63 +92,12 @@ public class NotificationPreferencesPersistenceService {
} }
// This method intentionally does not have a @Transactional annotation, since it needs to handle an underlying transaction exception.
public NotificationPreferences getOrCreateNotificationPreferences(String userId) {
try {
// The method called here will fail if it is called concurrently (more than 1 thread), since it will always try to create
// the desired entity. But the exception only means, that the entity has been created by another thread.
// In that case we can just fetch the data from the db.
return notificationPreferencesRepositoryWrapper.getOrCreateNotificationPreferences(userId);
} catch (DataIntegrityViolationException ex) {
return notificationPreferencesRepositoryWrapper.getByUserId(userId);
}
}
@Transactional
public void initializePreferencesIfNotExists(String userId) {
getOrCreateNotificationPreferences(userId);
}
public List<NotificationPreferencesEntity> findAll() { public List<NotificationPreferencesEntity> findAll() {
return notificationPreferencesRepository.findAll(); return notificationPreferencesRepository.findAll();
} }
@Component
@RequiredArgsConstructor
@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)
private static class NonThreadSafeNotificationPreferencesRepositoryWrapper {
NotificationPreferencesRepository notificationPreferencesRepository;
@Transactional(Transactional.TxType.REQUIRES_NEW)
public NotificationPreferences getByUserId(String userId){
return convertPreferences(notificationPreferencesRepository.getByUserId(userId));
}
@Transactional(Transactional.TxType.REQUIRES_NEW)
public NotificationPreferences getOrCreateNotificationPreferences(String userId) {
var preferences = notificationPreferencesRepository.findByUserId(userId).orElseGet(() -> {
var notificationPreference = new NotificationPreferencesEntity();
notificationPreference.setUserId(userId);
notificationPreference.setEmailNotificationsEnabled(false);
notificationPreference.setInAppNotificationsEnabled(true);
notificationPreference.setInAppNotifications(Arrays.stream(NotificationType.values()).map(Enum::name).collect(Collectors.toList()));
return notificationPreferencesRepository.save(notificationPreference);
});
return convertPreferences(preferences);
}
private NotificationPreferences convertPreferences(NotificationPreferencesEntity preferences){ private NotificationPreferences convertPreferences(NotificationPreferencesEntity preferences){
var result = MagicConverter.convert(preferences, NotificationPreferences.class); var result = MagicConverter.convert(preferences, NotificationPreferences.class);
@ -138,5 +107,3 @@ public class NotificationPreferencesPersistenceService {
} }
} }
}

View File

@ -10,10 +10,6 @@ public interface NotificationPreferencesRepository extends JpaRepository<Notific
Optional<NotificationPreferencesEntity> findByUserId(String userId); Optional<NotificationPreferencesEntity> findByUserId(String userId);
NotificationPreferencesEntity getByUserId(String userId);
void deleteByUserId(String userId); void deleteByUserId(String userId);
} }

View File

@ -8,6 +8,7 @@ import org.springframework.beans.factory.annotation.Autowired;
import com.iqser.red.service.peristence.v1.server.integration.utils.AbstractPersistenceServerServiceTest; import com.iqser.red.service.peristence.v1.server.integration.utils.AbstractPersistenceServerServiceTest;
import com.iqser.red.service.peristence.v1.server.integration.utils.MultithreadedTestRunner; import com.iqser.red.service.peristence.v1.server.integration.utils.MultithreadedTestRunner;
import com.iqser.red.service.persistence.management.v1.processor.service.NotificationPreferencesService;
import com.iqser.red.service.persistence.management.v1.processor.service.persistence.NotificationPreferencesPersistenceService; import com.iqser.red.service.persistence.management.v1.processor.service.persistence.NotificationPreferencesPersistenceService;
import com.knecon.fforesight.tenantcommons.TenantContext; import com.knecon.fforesight.tenantcommons.TenantContext;
@ -20,6 +21,10 @@ import lombok.extern.slf4j.Slf4j;
@FieldDefaults(level = AccessLevel.PRIVATE) @FieldDefaults(level = AccessLevel.PRIVATE)
public class NotificationPreferencesServiceTest extends AbstractPersistenceServerServiceTest { public class NotificationPreferencesServiceTest extends AbstractPersistenceServerServiceTest {
@Autowired
NotificationPreferencesService notificationPreferencesService;
@Autowired @Autowired
NotificationPreferencesPersistenceService notificationPreferencesPersistenceService; NotificationPreferencesPersistenceService notificationPreferencesPersistenceService;
@ -38,7 +43,7 @@ public class NotificationPreferencesServiceTest extends AbstractPersistenceServe
public void testNotificationPreferencesConcurrent() { public void testNotificationPreferencesConcurrent() {
final String userId = "1"; final String userId = "1";
Runnable test = () -> notificationPreferencesPersistenceService.getOrCreateNotificationPreferences(userId); Runnable test = () -> notificationPreferencesService.getOrCreateNotificationPreferences(userId);
Runnable afterTest = () -> notificationPreferencesPersistenceService.deleteNotificationPreferences(userId); Runnable afterTest = () -> notificationPreferencesPersistenceService.deleteNotificationPreferences(userId);
var exceptions = multithreadedTestRunner.runMutlithreadedCollectingExceptions(test, afterTest); var exceptions = multithreadedTestRunner.runMutlithreadedCollectingExceptions(test, afterTest);