honeymoose
/
hapi-fhir
mirror of https://github.com/hapifhir/hapi-fhir.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

3829 Fix Subscriptions created with package installer and partitioning enabled bug (#3830) 

* - failing test + increase existing code coverage

* - fix: use RequestPartitionId.defaultPartition() to handle malformed default partitions

* - changelog

* - typo
This commit is contained in:
Nathan Doef 2022-07-22 13:12:07 -04:00 committed by GitHub
parent d2fd0989c3
commit cbcf3f1942
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 189 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/changelog/6_1_0/3829-fix-subscriptions-created-with-package-installer-and-partitioning-enabled.yaml Normal file
View File

@ -0,0 +1,8 @@
---
type: fix
issue: 3829
jira: SMILE-4178
title: "Previously when a `Subscription` was created using the package installer and with partitioning enabled,
there was an error reading the partition name inside the `SubscriptionRegisteringSubscriber`. This fix checks
incoming `Subscription` requests for a `RequestPartitionId` with a list of partition names containing null values
and uses `RequestPartitionId#defaultPartition()` to obtain the default partition instead."

20
hapi-fhir-jpaserver-subscription/src/main/java/ca/uhn/fhir/jpa/subscription/match/matcher/subscriber/SubscriptionRegisteringSubscriber.java
View File

@ -21,6 +21,8 @@ package ca.uhn.fhir.jpa.subscription.match.matcher.subscriber;
*/
import ca.uhn.fhir.context.FhirContext;
import ca.uhn.fhir.context.support.IValidationSupport;
import ca.uhn.fhir.interceptor.model.RequestPartitionId;
import ca.uhn.fhir.jpa.api.dao.DaoRegistry;
import ca.uhn.fhir.jpa.api.dao.IFhirResourceDao;
import ca.uhn.fhir.jpa.partition.SystemRequestDetails;
@ -97,7 +99,7 @@ public class SubscriptionRegisteringSubscriber extends BaseSubscriberForSubscrip
IIdType payloadId = payload.getPayloadId(myFhirContext).toUnqualifiedVersionless();
try {
IFhirResourceDao<?> subscriptionDao = myDaoRegistry.getResourceDao("Subscription");
RequestDetails systemRequestDetails = new SystemRequestDetails().setRequestPartitionId(payload.getPartitionId());
RequestDetails systemRequestDetails = getPartitionAwareRequestDetails(payload);
payloadResource = subscriptionDao.read(payloadId, systemRequestDetails);
if (payloadResource == null) {
// Only for unit test
@ -117,4 +119,20 @@ public class SubscriptionRegisteringSubscriber extends BaseSubscriberForSubscrip
}
/**
* There were some situations where the RequestDetails attempted to use the default partition
* and the partition name was a list containing null values (i.e. using the package installer to STORE_AND_INSTALL
* Subscriptions while partitioning was enabled). If any partition matches these criteria,
* {@link RequestPartitionId#defaultPartition()} is used to obtain the default partition.
*/
private RequestDetails getPartitionAwareRequestDetails(ResourceModifiedMessage payload) {
RequestPartitionId partitionId = payload.getPartitionId();
// This was occurring with the package installer to STORE_AND_INSTALL Subscriptions while partitioning was enabled
if(partitionId == null || partitionId.getFirstPartitionNameOrNull() == null){
partitionId= RequestPartitionId.defaultPartition();
}
RequestDetails systemRequestDetails = new SystemRequestDetails().setRequestPartitionId(partitionId);
return systemRequestDetails;
}
}

162
hapi-fhir-jpaserver-subscription/src/test/java/ca/uhn/fhir/jpa/subscription/match/matcher/subscriber/SubscriptionRegisteringSubscriberTest.java Normal file
View File

@ -0,0 +1,162 @@
package ca.uhn.fhir.jpa.subscription.match.matcher.subscriber;
import ca.uhn.fhir.context.FhirContext;
import ca.uhn.fhir.interceptor.model.RequestPartitionId;
import ca.uhn.fhir.jpa.api.dao.DaoRegistry;
import ca.uhn.fhir.jpa.api.dao.IFhirResourceDao;
import ca.uhn.fhir.jpa.partition.SystemRequestDetails;
import ca.uhn.fhir.jpa.subscription.match.registry.SubscriptionCanonicalizer;
import ca.uhn.fhir.jpa.subscription.match.registry.SubscriptionRegistry;
import ca.uhn.fhir.jpa.subscription.model.ResourceModifiedJsonMessage;
import ca.uhn.fhir.jpa.subscription.model.ResourceModifiedMessage;
import ca.uhn.fhir.rest.api.server.RequestDetails;
import ca.uhn.fhir.rest.server.exceptions.ResourceGoneException;
import ca.uhn.fhir.rest.server.messaging.BaseResourceMessage;
import ca.uhn.fhir.rest.server.messaging.json.ResourceOperationJsonMessage;
import org.hl7.fhir.r4.model.Subscription;
import org.hl7.fhir.r4.model.codesystems.SubscriptionStatus;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.Spy;
import org.mockito.junit.jupiter.MockitoExtension;
import org.springframework.boot.test.system.CapturedOutput;
import org.springframework.boot.test.system.OutputCaptureExtension;
import java.time.LocalDate;
import java.util.Arrays;
import java.util.List;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
@ExtendWith({MockitoExtension.class, OutputCaptureExtension.class})
public class SubscriptionRegisteringSubscriberTest {
@Spy
private FhirContext myFhirContext = FhirContext.forR4Cached();
@Mock
private SubscriptionRegistry mySubscriptionRegistry;
@Mock
private SubscriptionCanonicalizer mySubscriptionCanonicalizer;
@Mock
private DaoRegistry myDaoRegistry;
@Mock
private IFhirResourceDao<Subscription> mySubscriptionDao;
@InjectMocks
private SubscriptionRegisteringSubscriber mySubscriptionRegisteringSubscriber;
@Captor
private ArgumentCaptor<RequestDetails> requestDetailsCaptor;
private Subscription mySubscription;
@BeforeEach
public void beforeEach() {
mySubscription = new Subscription();
mySubscription.setId("Subscription/testrest");
}
@Test
public void testHandleMessageNonResourceModifiedJsonMessage(CapturedOutput output){
ResourceOperationJsonMessage message = new ResourceOperationJsonMessage();
mySubscriptionRegisteringSubscriber.handleMessage(message);
String expectedMessage = String.format("Received message of unexpected type on matching channel: %s", message);
assertTrue(output.getOut().contains(expectedMessage));
}
@Test
public void testHandleMessageSubscriptionResourceGone(){
ResourceModifiedMessage resourceModifiedMessage = new ResourceModifiedMessage(myFhirContext, mySubscription, BaseResourceMessage.OperationTypeEnum.CREATE);
ResourceModifiedJsonMessage message = new ResourceModifiedJsonMessage(resourceModifiedMessage);
when(myDaoRegistry.getResourceDao("Subscription")).thenReturn(mySubscriptionDao);
when(mySubscriptionDao.read(any(), any())).thenThrow(ResourceGoneException.class);
mySubscriptionRegisteringSubscriber.handleMessage(message);
verify(mySubscriptionRegistry, times(1)).unregisterSubscriptionIfRegistered(any());
verify(mySubscriptionRegistry, never()).registerSubscriptionUnlessAlreadyRegistered(any());
}
@Test
public void testHandleMessageSubscriptionActiveStatus(){
ResourceModifiedMessage resourceModifiedMessage = new ResourceModifiedMessage(myFhirContext, mySubscription, BaseResourceMessage.OperationTypeEnum.CREATE);
ResourceModifiedJsonMessage message = new ResourceModifiedJsonMessage(resourceModifiedMessage);
when(myDaoRegistry.getResourceDao("Subscription")).thenReturn(mySubscriptionDao);
when(mySubscriptionDao.read(any(), any())).thenReturn(mySubscription);
when(mySubscriptionCanonicalizer.getSubscriptionStatus(mySubscription)).thenReturn(SubscriptionStatus.ACTIVE.toCode());
mySubscriptionRegisteringSubscriber.handleMessage(message);
verify(mySubscriptionRegistry, never()).unregisterSubscriptionIfRegistered(any());
verify(mySubscriptionRegistry, times(1)).registerSubscriptionUnlessAlreadyRegistered(any());
}
@Test
public void testHandleMessageSubscriptionErrorStatus(){
ResourceModifiedMessage resourceModifiedMessage = new ResourceModifiedMessage(myFhirContext, mySubscription, BaseResourceMessage.OperationTypeEnum.CREATE);
ResourceModifiedJsonMessage message = new ResourceModifiedJsonMessage(resourceModifiedMessage);
when(myDaoRegistry.getResourceDao("Subscription")).thenReturn(mySubscriptionDao);
when(mySubscriptionDao.read(any(), any())).thenReturn(mySubscription);
when(mySubscriptionCanonicalizer.getSubscriptionStatus(mySubscription)).thenReturn(SubscriptionStatus.ERROR.toCode());
mySubscriptionRegisteringSubscriber.handleMessage(message);
verify(mySubscriptionRegistry, times(1)).unregisterSubscriptionIfRegistered(any());
verify(mySubscriptionRegistry, never()).registerSubscriptionUnlessAlreadyRegistered(any());
}
@Test
public void testHandleMessagePartitionWithNullPartitionName(){
List<Integer> partitionIds = Arrays.asList((Integer)null);
List<String> partitionNames = Arrays.asList((String)null);
LocalDate localDate = null;
RequestPartitionId requestPartitionId = RequestPartitionId.forPartitionIdsAndNames(partitionNames, partitionIds, localDate);
ResourceModifiedMessage resourceModifiedMessage = new ResourceModifiedMessage(myFhirContext, mySubscription, BaseResourceMessage.OperationTypeEnum.CREATE);
resourceModifiedMessage.setPartitionId(requestPartitionId);
ResourceModifiedJsonMessage message = new ResourceModifiedJsonMessage(resourceModifiedMessage);
when(myDaoRegistry.getResourceDao("Subscription")).thenReturn(mySubscriptionDao);
when(mySubscriptionDao.read(any(), requestDetailsCaptor.capture())).thenReturn(mySubscription);
when(mySubscriptionCanonicalizer.getSubscriptionStatus(mySubscription)).thenReturn(SubscriptionStatus.ACTIVE.toCode());
mySubscriptionRegisteringSubscriber.handleMessage(message);
SystemRequestDetails details = (SystemRequestDetails)requestDetailsCaptor.getValue();
// ensure partitions with list of names containing null use the default partition
assertNull(details.getRequestPartitionId().getPartitionNames());
assertNull(details.getRequestPartitionId().getFirstPartitionIdOrNull());
verify(mySubscriptionRegistry, never()).unregisterSubscriptionIfRegistered(any());
verify(mySubscriptionRegistry, times(1)).registerSubscriptionUnlessAlreadyRegistered(any());
}
@Test
public void testHandleMessageWithNullPartition(){
RequestPartitionId requestPartitionId = null;
ResourceModifiedMessage resourceModifiedMessage = new ResourceModifiedMessage(myFhirContext, mySubscription, BaseResourceMessage.OperationTypeEnum.CREATE);
resourceModifiedMessage.setPartitionId(requestPartitionId);
ResourceModifiedJsonMessage message = new ResourceModifiedJsonMessage(resourceModifiedMessage);
when(myDaoRegistry.getResourceDao("Subscription")).thenReturn(mySubscriptionDao);
when(mySubscriptionDao.read(any(), requestDetailsCaptor.capture())).thenReturn(mySubscription);
when(mySubscriptionCanonicalizer.getSubscriptionStatus(mySubscription)).thenReturn(SubscriptionStatus.ACTIVE.toCode());
mySubscriptionRegisteringSubscriber.handleMessage(message);
SystemRequestDetails details = (SystemRequestDetails)requestDetailsCaptor.getValue();
// ensure partitions that are null use the default partition
assertNull(details.getRequestPartitionId().getPartitionNames());
assertNull(details.getRequestPartitionId().getFirstPartitionIdOrNull());
verify(mySubscriptionRegistry, never()).unregisterSubscriptionIfRegistered(any());
verify(mySubscriptionRegistry, times(1)).registerSubscriptionUnlessAlreadyRegistered(any());
}
}