diff --git a/adyencheckoutaddonapi/acceleratoraddon/web/src/com/adyen/commerce/api/controllers/api/AdyenDonationsController.java b/adyencheckoutaddonapi/acceleratoraddon/web/src/com/adyen/commerce/api/controllers/api/AdyenDonationsController.java index 5bc37c264..db532e848 100644 --- a/adyencheckoutaddonapi/acceleratoraddon/web/src/com/adyen/commerce/api/controllers/api/AdyenDonationsController.java +++ b/adyencheckoutaddonapi/acceleratoraddon/web/src/com/adyen/commerce/api/controllers/api/AdyenDonationsController.java @@ -12,6 +12,7 @@ import com.adyen.model.checkout.DonationCampaignsResponse; import com.adyen.model.checkout.DonationPaymentResponse; import com.adyen.service.exception.ApiException; +import com.google.gson.Gson; import de.hybris.platform.acceleratorservices.urlresolver.SiteBaseUrlResolutionService; import de.hybris.platform.basecommerce.model.site.BaseSiteModel; import de.hybris.platform.servicelayer.session.SessionService; @@ -27,22 +28,22 @@ import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.stereotype.Controller; -import org.springframework.web.bind.annotation.GetMapping; -import org.springframework.web.bind.annotation.PostMapping; -import org.springframework.web.bind.annotation.RequestBody; -import org.springframework.web.bind.annotation.RequestMapping; -import org.springframework.web.bind.annotation.ResponseBody; +import org.springframework.web.bind.annotation.*; import java.io.IOException; +import java.util.Arrays; import java.util.Collections; import java.util.List; import java.util.UUID; -@Controller +@RestController @RequestMapping("/api/checkout/donations") public class AdyenDonationsController { private static final Logger LOG = Logger.getLogger(AdyenDonationsController.class); private static final String COMPLETED = "completed"; + private static final String SESSION_DONATION_CAMPAIGNS = "adyen_donation_campaigns"; + private static final String SESSION_DONATION_CAMPAIGNS_CURRENCY = "adyen_donation_campaigns_currency"; + private static final Gson GSON = new Gson(); private static final DonationCampaignValidator DONATION_CAMPAIGN_VALIDATOR = new DonationCampaignValidator(); @@ -65,7 +66,6 @@ public class AdyenDonationsController { private SiteBaseUrlResolutionService siteBaseUrlResolutionService; @GetMapping(value = "/context", produces = "application/json") - @ResponseBody public ResponseEntity getContext() { if (!adyenDonationsFacade.isGivingEnabled()) { return ResponseEntity.noContent().build(); @@ -77,6 +77,8 @@ public ResponseEntity getContext() { final String currency = sessionService.getAttribute(DefaultAdyenCheckoutFacade.SESSION_DONATION_ORIGINAL_AMOUNT_CURRENCY); final String countryCode = sessionService.getAttribute(DefaultAdyenCheckoutFacade.SESSION_DONATION_COUNTRY_CODE); + clearDonationCampaignCache(); + if (StringUtils.isAnyBlank(donationToken, originalPspReference, currency, countryCode) || commercialTxAmount == null) { LOG.info("Giving context unavailable: token=" + StringUtils.isNotBlank(donationToken) + ", pspReference=" + StringUtils.isNotBlank(originalPspReference) @@ -101,6 +103,7 @@ public ResponseEntity getContext() { if (campaigns.isEmpty()) { return ResponseEntity.noContent().build(); } + cacheDonationCampaigns(currency, campaigns); return ResponseEntity.ok(new DonationContextResponse(baseStore.getAdyenClientKey(), adyenCheckoutFacade.getEnvironmentMode(), adyenCheckoutFacade.getShopperLocale(), @@ -108,7 +111,6 @@ public ResponseEntity getContext() { } @PostMapping(value = "/donate", consumes = "application/json", produces = "application/json") - @ResponseBody public ResponseEntity donate(@Valid @RequestBody final DonationRequest request, final HttpServletRequest httpServletRequest) { if (!adyenDonationsFacade.isGivingEnabled()) { @@ -127,7 +129,7 @@ public ResponseEntity donate(@Valid @RequestBody final Donatio final DonationCampaign campaign; try { - campaign = findCampaign(request.getDonationCampaignId(), getCampaigns(request.getAmount().getCurrency())); + campaign = findCampaign(request.getDonationCampaignId(), getCampaignsForDonation(request.getAmount().getCurrency())); } catch (ApiException | IOException exception) { LOG.warn("Unable to validate Adyen Giving campaign", exception); return ResponseEntity.status(HttpStatus.BAD_GATEWAY).build(); @@ -207,7 +209,36 @@ protected void clearDonationContext(final HttpSession httpSession) { sessionService.removeAttribute(DefaultAdyenCheckoutFacade.SESSION_DONATION_IN_PROGRESS); sessionService.removeAttribute(DefaultAdyenCheckoutFacade.SESSION_DONATION_IDEMPOTENCY_KEY); sessionService.removeAttribute(DefaultAdyenCheckoutFacade.SESSION_DONATION_REFERENCE); + clearDonationCampaignCache(); + } + } + + protected List getCampaignsForDonation(final String currency) throws IOException, ApiException { + final String cachedCurrency = sessionService.getAttribute(SESSION_DONATION_CAMPAIGNS_CURRENCY); + final String cachedCampaigns = sessionService.getAttribute(SESSION_DONATION_CAMPAIGNS); + if (StringUtils.equalsIgnoreCase(currency, cachedCurrency) + && StringUtils.isNotBlank(cachedCampaigns)) { + final DonationCampaign[] cachedCampaignArray = GSON.fromJson(cachedCampaigns, DonationCampaign[].class); + final List campaigns = cachedCampaignArray == null + ? null : Arrays.asList(cachedCampaignArray); + if (campaigns != null) { + return campaigns; + } } + + final List campaigns = getCampaigns(currency); + cacheDonationCampaigns(currency, campaigns); + return campaigns; + } + + protected void cacheDonationCampaigns(final String currency, final List campaigns) { + sessionService.setAttribute(SESSION_DONATION_CAMPAIGNS, GSON.toJson(campaigns)); + sessionService.setAttribute(SESSION_DONATION_CAMPAIGNS_CURRENCY, currency); + } + + protected void clearDonationCampaignCache() { + sessionService.removeAttribute(SESSION_DONATION_CAMPAIGNS); + sessionService.removeAttribute(SESSION_DONATION_CAMPAIGNS_CURRENCY); } protected String getOrCreateDonationIdempotencyKey() { diff --git a/adyenv6core/resources/adyenv6core-items.xml b/adyenv6core/resources/adyenv6core-items.xml index b4a5eeca8..62f01130e 100644 --- a/adyenv6core/resources/adyenv6core-items.xml +++ b/adyenv6core/resources/adyenv6core-items.xml @@ -819,6 +819,52 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/adyenv6core/resources/adyenv6core-spring.xml b/adyenv6core/resources/adyenv6core-spring.xml index 61f593e1a..6d5d3d046 100644 --- a/adyenv6core/resources/adyenv6core-spring.xml +++ b/adyenv6core/resources/adyenv6core-spring.xml @@ -103,6 +103,17 @@ + + + + + + + + + + + @@ -530,6 +541,11 @@ + + + + + diff --git a/adyenv6core/src/com/adyen/v6/events/DonationEvent.java b/adyenv6core/src/com/adyen/v6/events/DonationEvent.java new file mode 100644 index 000000000..751c82efc --- /dev/null +++ b/adyenv6core/src/com/adyen/v6/events/DonationEvent.java @@ -0,0 +1,9 @@ +package com.adyen.v6.events; + +import com.adyen.v6.model.AdyenNotificationModel; + +public class DonationEvent extends AbstractNotificationEvent { + public DonationEvent(final AdyenNotificationModel adyenNotificationModel) { + super(adyenNotificationModel); + } +} diff --git a/adyenv6core/src/com/adyen/v6/events/builder/DonationEventBuilder.java b/adyenv6core/src/com/adyen/v6/events/builder/DonationEventBuilder.java new file mode 100644 index 000000000..b87aea3ce --- /dev/null +++ b/adyenv6core/src/com/adyen/v6/events/builder/DonationEventBuilder.java @@ -0,0 +1,12 @@ +package com.adyen.v6.events.builder; + +import com.adyen.v6.events.AbstractNotificationEvent; +import com.adyen.v6.events.DonationEvent; +import com.adyen.v6.model.AdyenNotificationModel; + +public class DonationEventBuilder extends AbstractNotificationEventBuilder { + @Override + public AbstractNotificationEvent buildEvent(final AdyenNotificationModel adyenNotificationModel) { + return new DonationEvent(adyenNotificationModel); + } +} diff --git a/adyenv6core/src/com/adyen/v6/jalo/AdyenDonation.java b/adyenv6core/src/com/adyen/v6/jalo/AdyenDonation.java new file mode 100644 index 000000000..4942877b8 --- /dev/null +++ b/adyenv6core/src/com/adyen/v6/jalo/AdyenDonation.java @@ -0,0 +1,20 @@ +package com.adyen.v6.jalo; + +import de.hybris.platform.jalo.Item; +import de.hybris.platform.jalo.JaloBusinessException; +import de.hybris.platform.jalo.SessionContext; +import de.hybris.platform.jalo.type.ComposedType; +import org.apache.log4j.Logger; + +public class AdyenDonation extends GeneratedAdyenDonation +{ + @SuppressWarnings("unused") + private static final Logger LOG = Logger.getLogger( AdyenDonation.class.getName() ); + + @Override + protected Item createItem(final SessionContext ctx, final ComposedType type, final ItemAttributeMap allAttributes) throws JaloBusinessException + { + return super.createItem( ctx, type, allAttributes ); + } + +} diff --git a/adyenv6core/src/com/adyen/v6/listeners/DonationNotificationEventListener.java b/adyenv6core/src/com/adyen/v6/listeners/DonationNotificationEventListener.java new file mode 100644 index 000000000..486bd9c47 --- /dev/null +++ b/adyenv6core/src/com/adyen/v6/listeners/DonationNotificationEventListener.java @@ -0,0 +1,32 @@ +package com.adyen.v6.listeners; + +import com.adyen.v6.events.DonationEvent; +import com.adyen.v6.model.AdyenNotificationModel; +import com.adyen.v6.service.AdyenDonationReconciliationService; +import org.apache.log4j.Logger; + +import java.util.Date; + +public class DonationNotificationEventListener extends AbstractNotificationEventListener { + private static final Logger LOG = Logger.getLogger(DonationNotificationEventListener.class); + + private AdyenDonationReconciliationService adyenDonationReconciliationService; + + @Override + protected void onEvent(final DonationEvent event) { + final AdyenNotificationModel notification = event.getNotificationRequestItem(); + try { + adyenDonationReconciliationService.reconcile(notification); + notification.setProcessedAt(new Date()); + getModelService().save(notification); + LOG.info("DONATION notification with PSP reference " + notification.getPspReference() + " was processed"); + } catch (final Exception exception) { + logException(notification, exception, LOG); + } + } + + public void setAdyenDonationReconciliationService( + final AdyenDonationReconciliationService adyenDonationReconciliationService) { + this.adyenDonationReconciliationService = adyenDonationReconciliationService; + } +} diff --git a/adyenv6core/src/com/adyen/v6/repository/AdyenDonationRepository.java b/adyenv6core/src/com/adyen/v6/repository/AdyenDonationRepository.java new file mode 100644 index 000000000..17ec4eace --- /dev/null +++ b/adyenv6core/src/com/adyen/v6/repository/AdyenDonationRepository.java @@ -0,0 +1,20 @@ +package com.adyen.v6.repository; + +import com.adyen.v6.model.AdyenDonationModel; +import de.hybris.platform.servicelayer.search.FlexibleSearchQuery; + +import java.util.Collections; + +public class AdyenDonationRepository extends AbstractRepository { + + public AdyenDonationModel findByReference(final String reference) { + if (reference == null) { + return null; + } + final FlexibleSearchQuery query = new FlexibleSearchQuery( + "SELECT {pk} FROM {" + AdyenDonationModel._TYPECODE + "}" + + " WHERE {" + AdyenDonationModel.REFERENCE + "} = ?reference", + Collections.singletonMap("reference", reference)); + return (AdyenDonationModel) getOneOrNull(query); + } +} diff --git a/adyenv6core/src/com/adyen/v6/repository/AdyenNotificationRepository.java b/adyenv6core/src/com/adyen/v6/repository/AdyenNotificationRepository.java new file mode 100644 index 000000000..274757c45 --- /dev/null +++ b/adyenv6core/src/com/adyen/v6/repository/AdyenNotificationRepository.java @@ -0,0 +1,27 @@ +package com.adyen.v6.repository; + +import com.adyen.v6.model.AdyenNotificationModel; +import de.hybris.platform.servicelayer.search.FlexibleSearchQuery; + +import java.util.HashMap; +import java.util.Map; + +public class AdyenNotificationRepository extends AbstractRepository { + + public boolean isProcessed(final String pspReference, final String eventCode, final boolean success) { + final Map parameters = new HashMap<>(); + parameters.put("pspReference", pspReference); + parameters.put("eventCode", eventCode); + parameters.put("success", success); + + final FlexibleSearchQuery query = new FlexibleSearchQuery( + "SELECT {pk} FROM {" + AdyenNotificationModel._TYPECODE + "}" + + " WHERE {" + AdyenNotificationModel.PSPREFERENCE + "} = ?pspReference" + + " AND {" + AdyenNotificationModel.EVENTCODE + "} = ?eventCode" + + " AND {" + AdyenNotificationModel.SUCCESS + "} = ?success" + + " AND {" + AdyenNotificationModel.PROCESSEDAT + "} IS NOT NULL", + parameters); + query.setCount(1); + return !getFlexibleSearchService().search(query).getResult().isEmpty(); + } +} diff --git a/adyenv6core/src/com/adyen/v6/service/AdyenDonationReconciliationService.java b/adyenv6core/src/com/adyen/v6/service/AdyenDonationReconciliationService.java new file mode 100644 index 000000000..135a7abf4 --- /dev/null +++ b/adyenv6core/src/com/adyen/v6/service/AdyenDonationReconciliationService.java @@ -0,0 +1,7 @@ +package com.adyen.v6.service; + +import com.adyen.v6.model.AdyenNotificationModel; + +public interface AdyenDonationReconciliationService { + void reconcile(AdyenNotificationModel notification); +} diff --git a/adyenv6core/src/com/adyen/v6/service/DefaultAdyenDonationReconciliationService.java b/adyenv6core/src/com/adyen/v6/service/DefaultAdyenDonationReconciliationService.java new file mode 100644 index 000000000..2094cdc59 --- /dev/null +++ b/adyenv6core/src/com/adyen/v6/service/DefaultAdyenDonationReconciliationService.java @@ -0,0 +1,79 @@ +package com.adyen.v6.service; + +import com.adyen.v6.model.AdyenDonationModel; +import com.adyen.v6.model.AdyenNotificationModel; +import com.adyen.v6.repository.AdyenDonationRepository; +import com.adyen.v6.repository.PaymentTransactionRepository; +import de.hybris.platform.core.model.order.OrderModel; +import de.hybris.platform.payment.model.PaymentTransactionModel; +import de.hybris.platform.servicelayer.model.ModelService; +import org.apache.commons.lang3.StringUtils; + +public class DefaultAdyenDonationReconciliationService implements AdyenDonationReconciliationService { + private static final String COMPLETED = "completed"; + private static final String REFUSED = "refused"; + private static final String DONATION_REFERENCE_SEPARATOR = "-donation-"; + + private ModelService modelService; + private AdyenDonationRepository adyenDonationRepository; + private PaymentTransactionRepository paymentTransactionRepository; + + @Override + public void reconcile(final AdyenNotificationModel notification) { + final String originalReference = resolveOriginalReference(notification); + if (StringUtils.isAnyBlank(notification.getMerchantReference(), originalReference)) { + final String message = "Cannot reconcile DONATION webhook without merchant or original PSP reference"; + throw new IllegalStateException(message); + } + + final PaymentTransactionModel transaction = paymentTransactionRepository + .getTransactionModel(originalReference); + if (transaction == null || !(transaction.getOrder() instanceof OrderModel)) { + final String message = "Cannot find order for DONATION webhook with original PSP reference " + + originalReference; + throw new IllegalStateException(message); + } + + AdyenDonationModel donation = adyenDonationRepository.findByReference(notification.getMerchantReference()); + if (donation == null) { + donation = modelService.create(AdyenDonationModel.class); + donation.setReference(notification.getMerchantReference()); + donation.setOrder((OrderModel) transaction.getOrder()); + } + + donation.setPspReference(notification.getPspReference()); + donation.setOriginalPspReference(originalReference); + donation.setStatus(Boolean.TRUE.equals(notification.getSuccess()) ? COMPLETED : REFUSED); + donation.setAmountValue(notification.getAmountValue()); + donation.setAmountCurrency(notification.getAmountCurrency()); + modelService.save(donation); + } + + protected String resolveOriginalReference(final AdyenNotificationModel notification) { + if (StringUtils.isNotBlank(notification.getOriginalReference())) { + return notification.getOriginalReference(); + } + final String merchantReference = notification.getMerchantReference(); + if (merchantReference == null) { + return null; + } + final int index = merchantReference.lastIndexOf(DONATION_REFERENCE_SEPARATOR); + if (index <= 0) { + return null; + } + final String suffix = merchantReference.substring(index + DONATION_REFERENCE_SEPARATOR.length()); + return StringUtils.isNumeric(suffix) ? merchantReference.substring(0, index) : null; + } + + public void setModelService(final ModelService modelService) { + this.modelService = modelService; + } + + public void setAdyenDonationRepository(final AdyenDonationRepository adyenDonationRepository) { + this.adyenDonationRepository = adyenDonationRepository; + } + + public void setPaymentTransactionRepository(final PaymentTransactionRepository paymentTransactionRepository) { + this.paymentTransactionRepository = paymentTransactionRepository; + } +} diff --git a/adyenv6core/testsrc/com/adyen/v6/listeners/DonationNotificationEventListenerTest.java b/adyenv6core/testsrc/com/adyen/v6/listeners/DonationNotificationEventListenerTest.java new file mode 100644 index 000000000..d730b07c2 --- /dev/null +++ b/adyenv6core/testsrc/com/adyen/v6/listeners/DonationNotificationEventListenerTest.java @@ -0,0 +1,56 @@ +package com.adyen.v6.listeners; + +import com.adyen.v6.events.DonationEvent; +import com.adyen.v6.model.AdyenNotificationModel; +import com.adyen.v6.service.AdyenDonationReconciliationService; +import de.hybris.bootstrap.annotations.UnitTest; +import de.hybris.platform.servicelayer.model.ModelService; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.junit.MockitoJUnitRunner; + +import java.util.Date; + +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.doThrow; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; + +@UnitTest +@RunWith(MockitoJUnitRunner.class) +public class DonationNotificationEventListenerTest { + + @Mock + private ModelService modelServiceMock; + + @Mock + private AdyenDonationReconciliationService adyenDonationReconciliationService; + + @InjectMocks + private DonationNotificationEventListener listener; + + @Test + public void marksNotificationAsProcessedAfterReconciliation() { + final AdyenNotificationModel notification = mock(AdyenNotificationModel.class); + + listener.onEvent(new DonationEvent(notification)); + + verify(adyenDonationReconciliationService).reconcile(notification); + verify(notification).setProcessedAt(any(Date.class)); + verify(modelServiceMock).save(notification); + } + + @Test + public void leavesNotificationUnprocessedWhenReconciliationFails() { + final AdyenNotificationModel notification = mock(AdyenNotificationModel.class); + doThrow(new IllegalStateException("missing data")).when(adyenDonationReconciliationService).reconcile(notification); + + listener.onEvent(new DonationEvent(notification)); + + verify(notification, never()).setProcessedAt(any()); + verify(modelServiceMock, never()).save(notification); + } +} diff --git a/adyenv6core/testsrc/com/adyen/v6/service/DefaultAdyenDonationReconciliationServiceTest.java b/adyenv6core/testsrc/com/adyen/v6/service/DefaultAdyenDonationReconciliationServiceTest.java new file mode 100644 index 000000000..2e05610da --- /dev/null +++ b/adyenv6core/testsrc/com/adyen/v6/service/DefaultAdyenDonationReconciliationServiceTest.java @@ -0,0 +1,170 @@ +package com.adyen.v6.service; + +import com.adyen.v6.model.AdyenDonationModel; +import com.adyen.v6.model.AdyenNotificationModel; +import com.adyen.v6.repository.AdyenDonationRepository; +import com.adyen.v6.repository.PaymentTransactionRepository; +import de.hybris.bootstrap.annotations.UnitTest; +import de.hybris.platform.core.model.order.OrderModel; +import de.hybris.platform.payment.model.PaymentTransactionModel; +import de.hybris.platform.servicelayer.model.ModelService; +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.Mock; +import org.mockito.junit.MockitoJUnitRunner; + +import java.math.BigDecimal; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.fail; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.*; + +@UnitTest +@RunWith(MockitoJUnitRunner.class) +public class DefaultAdyenDonationReconciliationServiceTest { + @Mock + private ModelService modelService; + @Mock + private AdyenDonationRepository donationRepository; + @Mock + private PaymentTransactionRepository paymentTransactionRepository; + @Mock + private PaymentTransactionModel transaction; + @Mock + private OrderModel order; + @Mock + private AdyenDonationModel donation; + + private DefaultAdyenDonationReconciliationService service; + + @Before + public void setUp() { + service = new DefaultAdyenDonationReconciliationService(); + service.setModelService(modelService); + service.setAdyenDonationRepository(donationRepository); + service.setPaymentTransactionRepository(paymentTransactionRepository); + } + + @Test + public void createsCompletedDonationLinkedToOrder() { + final AdyenNotificationModel notification = donationNotification(true); + when(paymentTransactionRepository.getTransactionModel("original-psp")).thenReturn(transaction); + when(transaction.getOrder()).thenReturn(order); + when(donationRepository.findByReference("donation-reference")).thenReturn(null); + when(modelService.create(AdyenDonationModel.class)).thenReturn(donation); + + service.reconcile(notification); + + verify(donation).setReference("donation-reference"); + verify(donation).setOrder(order); + verify(donation).setStatus("completed"); + verify(donation).setPspReference("donation-psp"); + verify(modelService).save(donation); + } + + @Test + public void updatesExistingDonationWithoutCreatingAnotherOne() { + final AdyenNotificationModel notification = donationNotification(false); + when(paymentTransactionRepository.getTransactionModel("original-psp")).thenReturn(transaction); + when(transaction.getOrder()).thenReturn(order); + when(donationRepository.findByReference("donation-reference")).thenReturn(donation); + + service.reconcile(notification); + + verify(modelService, never()).create(AdyenDonationModel.class); + verify(donation).setStatus("refused"); + verify(modelService).save(donation); + } + + @Test + public void throwsWhenOriginalPaymentCannotBeMatchedToAnOrder() { + when(paymentTransactionRepository.getTransactionModel("original-psp")).thenReturn(null); + + try { + service.reconcile(donationNotification(true)); + fail("Expected IllegalStateException"); + } catch (final IllegalStateException expected) { + // expected + } + + verify(modelService, never()).create(any(Class.class)); + verify(modelService, never()).save(any()); + } + + @Test + public void derivesOriginalReferenceFromMerchantReferenceWhenMissing() { + final AdyenNotificationModel notification = donationNotification(true); + when(notification.getOriginalReference()).thenReturn(null); + when(notification.getMerchantReference()).thenReturn("ORIG-1-donation-1700000000000"); + when(paymentTransactionRepository.getTransactionModel("ORIG-1")).thenReturn(transaction); + when(transaction.getOrder()).thenReturn(order); + when(donationRepository.findByReference("ORIG-1-donation-1700000000000")).thenReturn(null); + when(modelService.create(AdyenDonationModel.class)).thenReturn(donation); + + service.reconcile(notification); + + verify(donation).setOriginalPspReference("ORIG-1"); + verify(modelService).save(donation); + } + + @Test + public void usesLastDonationSeparatorWhenDerivingOriginalReference() { + final AdyenNotificationModel notification = mock(AdyenNotificationModel.class, withSettings().lenient()); + when(notification.getMerchantReference()).thenReturn("A-donation-B-donation-123"); + + assertEquals("A-donation-B", service.resolveOriginalReference(notification)); + } + + @Test + public void doesNotDeriveOriginalReferenceFromNonDonationMerchantReference() { + final AdyenNotificationModel notification = mock(AdyenNotificationModel.class, withSettings().lenient()); + when(notification.getMerchantReference()).thenReturn("order-123", "ORIG-donation-abc"); + assertNull(service.resolveOriginalReference(notification)); + assertNull(service.resolveOriginalReference(notification)); + } + + @Test + public void throwsWhenNoOriginalReferenceCanBeResolved() { + final AdyenNotificationModel notification = donationNotification(true); + when(notification.getOriginalReference()).thenReturn(null); + when(notification.getMerchantReference()).thenReturn("order-123"); + + try { + service.reconcile(notification); + fail("Expected IllegalStateException"); + } catch (final IllegalStateException expected) { + // expected + } + + verify(modelService, never()).save(any()); + } + + @Test + public void throwsWhenMerchantReferenceIsMissing() { + final AdyenNotificationModel notification = donationNotification(true); + when(notification.getMerchantReference()).thenReturn(null); + + try { + service.reconcile(notification); + fail("Expected IllegalStateException"); + } catch (final IllegalStateException expected) { + // expected + } + + verify(modelService, never()).save(any()); + } + + private AdyenNotificationModel donationNotification(final boolean success) { + final AdyenNotificationModel notification = mock(AdyenNotificationModel.class, withSettings().lenient()); + when(notification.getMerchantReference()).thenReturn("donation-reference"); + when(notification.getOriginalReference()).thenReturn("original-psp"); + when(notification.getPspReference()).thenReturn("donation-psp"); + when(notification.getAmountValue()).thenReturn(BigDecimal.valueOf(1000)); + when(notification.getAmountCurrency()).thenReturn("EUR"); + when(notification.getSuccess()).thenReturn(success); + return notification; + } +} diff --git a/adyenv6notificationv2/resources/adyenv6notificationv2-spring.xml b/adyenv6notificationv2/resources/adyenv6notificationv2-spring.xml index f9deac891..094eeb4a1 100644 --- a/adyenv6notificationv2/resources/adyenv6notificationv2-spring.xml +++ b/adyenv6notificationv2/resources/adyenv6notificationv2-spring.xml @@ -10,6 +10,7 @@ + diff --git a/adyenv6notificationv2/src/com/adyen/v6/service/impl/DefaultAdyenNotificationV2Service.java b/adyenv6notificationv2/src/com/adyen/v6/service/impl/DefaultAdyenNotificationV2Service.java index f04b9801e..3c970456f 100644 --- a/adyenv6notificationv2/src/com/adyen/v6/service/impl/DefaultAdyenNotificationV2Service.java +++ b/adyenv6notificationv2/src/com/adyen/v6/service/impl/DefaultAdyenNotificationV2Service.java @@ -5,6 +5,7 @@ import com.adyen.v6.events.AbstractNotificationEvent; import com.adyen.v6.events.builder.*; import com.adyen.v6.model.AdyenNotificationModel; +import com.adyen.v6.repository.AdyenNotificationRepository; import com.adyen.v6.service.AdyenNotificationV2Service; import com.google.gson.Gson; import de.hybris.platform.servicelayer.event.EventService; @@ -17,9 +18,11 @@ public class DefaultAdyenNotificationV2Service implements AdyenNotificationV2Service { private static final org.apache.log4j.Logger LOG = Logger.getLogger(DefaultAdyenNotificationV2Service.class); + private static final String EVENT_CODE_DONATION = "DONATION"; private ModelService modelService; private EventService eventService; + private AdyenNotificationRepository adyenNotificationRepository; private Map eventTemplateMap; @@ -32,12 +35,18 @@ public class DefaultAdyenNotificationV2Service implements AdyenNotificationV2Ser eventTemplateMap.put(NotificationRequestItem.EVENT_CODE_OFFER_CLOSED, new OfferClosedEventBuilder()); eventTemplateMap.put(NotificationRequestItem.EVENT_CODE_REFUND, new RefundEventBuilder()); eventTemplateMap.put(NotificationRequestItem.EVENT_CODE_CHARGEBACK, new ChargebackEventBuilder()); + eventTemplateMap.put(EVENT_CODE_DONATION, new DonationEventBuilder()); } @Override public void onRequest(final NotificationRequest notificationRequest) { for (NotificationRequestItem item : notificationRequest.getNotificationItems()) { try { + if (isDuplicate(item)) { + LOG.info("Ignoring already processed " + item.getEventCode() + + " notification with PSP reference " + item.getPspReference()); + continue; + } AdyenNotificationModel notificationModel = save(item); Optional optionalEvent = createEvent(notificationModel); optionalEvent.ifPresent(this::publish); @@ -47,6 +56,20 @@ public void onRequest(final NotificationRequest notificationRequest) { } } + protected boolean isDuplicate(final NotificationRequestItem item) { + if (!EVENT_CODE_DONATION.equals(item.getEventCode())) { + return false; + } + try { + return adyenNotificationRepository.isProcessed(item.getPspReference(), item.getEventCode(), item.isSuccess()); + } catch (RuntimeException e) { + // fail open: the donation upsert by reference is idempotent, so processing it again is safe + LOG.warn("Duplicate check failed for " + item.getEventCode() + " notification with PSP reference " + + item.getPspReference() + ", processing it anyway", e); + return false; + } + } + protected AdyenNotificationModel save(NotificationRequestItem notificationRequestItem) { AdyenNotificationModel adyenNotificationModel = populate(notificationRequestItem); modelService.save(adyenNotificationModel); @@ -55,7 +78,7 @@ protected AdyenNotificationModel save(NotificationRequestItem notificationReques protected AdyenNotificationModel populate(NotificationRequestItem source) { - AdyenNotificationModel target = new AdyenNotificationModel(); + AdyenNotificationModel target = modelService.create(AdyenNotificationModel.class); Gson gson = new Gson(); if (source.getAmount() != null) { target.setAmountCurrency(source.getAmount().getCurrency()); @@ -116,4 +139,8 @@ public EventService getEventService() { public void setEventService(EventService eventService) { this.eventService = eventService; } + + public void setAdyenNotificationRepository(final AdyenNotificationRepository adyenNotificationRepository) { + this.adyenNotificationRepository = adyenNotificationRepository; + } } diff --git a/adyenv6notificationv2/testsrc/com/adyen/v6/service/impl/DefaultAdyenNotificationV2ServiceTest.java b/adyenv6notificationv2/testsrc/com/adyen/v6/service/impl/DefaultAdyenNotificationV2ServiceTest.java new file mode 100644 index 000000000..79c575022 --- /dev/null +++ b/adyenv6notificationv2/testsrc/com/adyen/v6/service/impl/DefaultAdyenNotificationV2ServiceTest.java @@ -0,0 +1,133 @@ +package com.adyen.v6.service.impl; + +import com.adyen.model.notification.NotificationRequest; +import com.adyen.model.notification.NotificationRequestItem; +import com.adyen.v6.events.DonationEvent; +import com.adyen.v6.model.AdyenNotificationModel; +import com.adyen.v6.repository.AdyenNotificationRepository; +import de.hybris.bootstrap.annotations.UnitTest; +import de.hybris.platform.servicelayer.event.EventService; +import de.hybris.platform.servicelayer.model.ModelService; +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.Mock; +import org.mockito.junit.MockitoJUnitRunner; + +import java.util.Collections; + +import static org.junit.Assert.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.*; + +@UnitTest +@RunWith(MockitoJUnitRunner.class) +public class DefaultAdyenNotificationV2ServiceTest { + private static final String DONATION = "DONATION"; + + @Mock + private ModelService modelService; + @Mock + private EventService eventService; + @Mock + private AdyenNotificationRepository adyenNotificationRepository; + @Mock + private AdyenNotificationModel notificationModel; + + private DefaultAdyenNotificationV2Service service; + + @Before + public void setUp() { + service = new DefaultAdyenNotificationV2Service(); + service.setModelService(modelService); + service.setEventService(eventService); + service.setAdyenNotificationRepository(adyenNotificationRepository); + } + + @Test + public void createsDonationEventForDonationNotification() { + when(notificationModel.getEventCode()).thenReturn(DONATION); + + assertTrue(service.createEvent(notificationModel).orElseThrow() instanceof DonationEvent); + } + + @Test + public void ignoresAlreadyProcessedDonationNotification() { + final NotificationRequestItem item = donationNotification(); + final NotificationRequest request = new NotificationRequest(); + request.setNotificationItems(Collections.singletonList(item)); + when(adyenNotificationRepository.isProcessed("donation-psp", DONATION, true)).thenReturn(true); + + service.onRequest(request); + + verify(modelService, never()).save(any()); + verify(eventService, never()).publishEvent(any()); + } + + @Test + public void doesNotLookUpProcessedStateForNonDonationNotification() { + final NotificationRequestItem item = new NotificationRequestItem(); + item.setEventCode("AUTHORISATION"); + item.setPspReference("auth-psp"); + item.setSuccess(true); + final NotificationRequest request = new NotificationRequest(); + request.setNotificationItems(Collections.singletonList(item)); + when(modelService.create(AdyenNotificationModel.class)).thenReturn(notificationModel); + when(notificationModel.getEventCode()).thenReturn("AUTHORISATION"); + + service.onRequest(request); + + verify(adyenNotificationRepository, never()).isProcessed(any(), any(), anyBoolean()); + verify(modelService).save(notificationModel); + verify(eventService).publishEvent(any()); + } + + @Test + public void looksUpProcessedStateForDonationNotification() { + final NotificationRequest request = new NotificationRequest(); + request.setNotificationItems(Collections.singletonList(donationNotification())); + when(modelService.create(AdyenNotificationModel.class)).thenReturn(notificationModel); + when(notificationModel.getEventCode()).thenReturn(DONATION); + + service.onRequest(request); + + verify(adyenNotificationRepository).isProcessed("donation-psp", DONATION, true); + } + + @Test + public void processesDonationNotificationWhenDuplicateCheckFails() { + final NotificationRequest request = new NotificationRequest(); + request.setNotificationItems(Collections.singletonList(donationNotification())); + when(adyenNotificationRepository.isProcessed("donation-psp", DONATION, true)) + .thenThrow(new IllegalStateException("db down")); + when(modelService.create(AdyenNotificationModel.class)).thenReturn(notificationModel); + when(notificationModel.getEventCode()).thenReturn(DONATION); + + service.onRequest(request); + + verify(modelService).save(notificationModel); + verify(eventService).publishEvent(any(DonationEvent.class)); + } + + @Test + public void persistsAndPublishesNewDonationNotification() { + final NotificationRequestItem item = donationNotification(); + final NotificationRequest request = new NotificationRequest(); + request.setNotificationItems(Collections.singletonList(item)); + when(modelService.create(AdyenNotificationModel.class)).thenReturn(notificationModel); + when(notificationModel.getEventCode()).thenReturn(DONATION); + + service.onRequest(request); + + verify(modelService).save(notificationModel); + verify(eventService).publishEvent(any(DonationEvent.class)); + } + + private NotificationRequestItem donationNotification() { + final NotificationRequestItem item = new NotificationRequestItem(); + item.setEventCode(DONATION); + item.setPspReference("donation-psp"); + item.setSuccess(true); + return item; + } +} diff --git a/adyenv6notificationv2/web/src/com/adyen/v6/controller/AdyenNotificationControllerV2.java b/adyenv6notificationv2/web/src/com/adyen/v6/controller/AdyenNotificationControllerV2.java index f4931b6e5..df5f78f12 100644 --- a/adyenv6notificationv2/web/src/com/adyen/v6/controller/AdyenNotificationControllerV2.java +++ b/adyenv6notificationv2/web/src/com/adyen/v6/controller/AdyenNotificationControllerV2.java @@ -74,6 +74,7 @@ public String onReceive(@PathVariable final String baseSiteId, final HttpServlet } if (!adyenNotificationAuthenticationProvider.authenticate(request, notificationRequest, baseSiteId)) { + LOG.warn("Rejected Adyen notification because Basic Auth or HMAC validation failed"); return RESPONSE_NOT_ACCEPTED; } diff --git a/adyenv6notificationv2/web/testsrc/com/adyen/v6/controller/AdyenNotificationControllerV2Test.java b/adyenv6notificationv2/web/testsrc/com/adyen/v6/controller/AdyenNotificationControllerV2Test.java new file mode 100644 index 000000000..fbeb4bdd4 --- /dev/null +++ b/adyenv6notificationv2/web/testsrc/com/adyen/v6/controller/AdyenNotificationControllerV2Test.java @@ -0,0 +1,100 @@ +package com.adyen.v6.controller; + +import com.adyen.model.notification.NotificationRequest; +import com.adyen.v6.security.AdyenNotificationAuthenticationProvider; +import com.adyen.v6.service.AdyenNotificationService; +import com.adyen.v6.service.AdyenNotificationV2Service; +import de.hybris.bootstrap.annotations.UnitTest; +import jakarta.servlet.ReadListener; +import jakarta.servlet.ServletInputStream; +import jakarta.servlet.http.HttpServletRequest; +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.Mock; +import org.mockito.junit.MockitoJUnitRunner; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.lang.reflect.Field; + +import static org.junit.Assert.assertEquals; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.*; + +@UnitTest +@RunWith(MockitoJUnitRunner.class) +public class AdyenNotificationControllerV2Test { + @Mock + private HttpServletRequest request; + @Mock + private AdyenNotificationV2Service notificationV2Service; + @Mock + private AdyenNotificationAuthenticationProvider authenticationProvider; + @Mock + private AdyenNotificationService notificationService; + + private AdyenNotificationControllerV2 controller; + private NotificationRequest notificationRequest; + + @Before + public void setUp() throws Exception { + controller = new AdyenNotificationControllerV2(); + notificationRequest = new NotificationRequest(); + setField("adyenNotificationV2Service", notificationV2Service); + setField("adyenNotificationAuthenticationProvider", authenticationProvider); + setField("adyenNotificationService", notificationService); + when(request.getInputStream()).thenReturn(inputStream("{\"notificationItems\":[]}")); + when(notificationService.getNotificationRequestFromString(any())).thenReturn(notificationRequest); + } + + @Test + public void rejectsWebhookWhenHmacValidationFails() { + when(authenticationProvider.authenticate(eq(request), eq(notificationRequest), eq("electronics"))).thenReturn(false); + + assertEquals("[not-accepted]", controller.onReceive("electronics", request)); + + verify(notificationV2Service, never()).onRequest(any()); + } + + @Test + public void acceptsWebhookOnlyAfterAuthenticationSucceeds() { + when(authenticationProvider.authenticate(eq(request), eq(notificationRequest), eq("electronics"))).thenReturn(true); + + assertEquals("[accepted]", controller.onReceive("electronics", request)); + + verify(notificationV2Service).onRequest(notificationRequest); + } + + private void setField(final String fieldName, final Object value) throws Exception { + final Field field = AdyenNotificationControllerV2.class.getDeclaredField(fieldName); + field.setAccessible(true); + field.set(controller, value); + } + + private ServletInputStream inputStream(final String payload) { + final ByteArrayInputStream delegate = new ByteArrayInputStream(payload.getBytes()); + return new ServletInputStream() { + @Override + public boolean isFinished() { + return delegate.available() == 0; + } + + @Override + public boolean isReady() { + return true; + } + + @Override + public void setReadListener(final ReadListener readListener) { + // Synchronous test input stream. + } + + @Override + public int read() throws IOException { + return delegate.read(); + } + }; + } +}