Merge pull request #1563 from jamesagnew/ks-inmemory-source

in-memory _source search

hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/api/RestSearchParameterTypeEnum.java

@@ -89,7 +89,7 @@ public enum RestSearchParameterTypeEnum {
 	 */
 	HAS("string", "http://hl7.org/fhir/search-param-type"),
 
-	/**
+		/**
 	 * Code Value: <b>number</b>
 	 *
 	 * Search parameter SHALL be a number (a whole number, or a decimal).

hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/param/ParameterUtil.java

@@ -61,43 +61,43 @@ public class ParameterUtil {
 	 * This is a utility method intended provided to help the JPA module.
 	 */
 	public static IQueryParameterAnd<?> parseQueryParams(FhirContext theContext, RestSearchParameterTypeEnum paramType,
-			String theUnqualifiedParamName, List<QualifiedParamList> theParameters) {
+																		  String theUnqualifiedParamName, List<QualifiedParamList> theParameters) {
 		QueryParameterAndBinder binder = null;
 		switch (paramType) {
-		case COMPOSITE:
+			case COMPOSITE:
-			throw new UnsupportedOperationException();
+				throw new UnsupportedOperationException();
-		case DATE:
+			case DATE:
-			binder = new QueryParameterAndBinder(DateAndListParam.class,
+				binder = new QueryParameterAndBinder(DateAndListParam.class,
-					Collections.<Class<? extends IQueryParameterType>> emptyList());
+					Collections.<Class<? extends IQueryParameterType>>emptyList());
-			break;
+				break;
-		case NUMBER:
+			case NUMBER:
-			binder = new QueryParameterAndBinder(NumberAndListParam.class,
+				binder = new QueryParameterAndBinder(NumberAndListParam.class,
-					Collections.<Class<? extends IQueryParameterType>> emptyList());
+					Collections.<Class<? extends IQueryParameterType>>emptyList());
-			break;
+				break;
-		case QUANTITY:
+			case QUANTITY:
-			binder = new QueryParameterAndBinder(QuantityAndListParam.class,
+				binder = new QueryParameterAndBinder(QuantityAndListParam.class,
-					Collections.<Class<? extends IQueryParameterType>> emptyList());
+					Collections.<Class<? extends IQueryParameterType>>emptyList());
-			break;
+				break;
-		case REFERENCE:
+			case REFERENCE:
-			binder = new QueryParameterAndBinder(ReferenceAndListParam.class,
+				binder = new QueryParameterAndBinder(ReferenceAndListParam.class,
-					Collections.<Class<? extends IQueryParameterType>> emptyList());
+					Collections.<Class<? extends IQueryParameterType>>emptyList());
-			break;
+				break;
-		case STRING:
+			case STRING:
-			binder = new QueryParameterAndBinder(StringAndListParam.class,
+				binder = new QueryParameterAndBinder(StringAndListParam.class,
-					Collections.<Class<? extends IQueryParameterType>> emptyList());
+					Collections.<Class<? extends IQueryParameterType>>emptyList());
-			break;
+				break;
-		case TOKEN:
+			case TOKEN:
-			binder = new QueryParameterAndBinder(TokenAndListParam.class,
+				binder = new QueryParameterAndBinder(TokenAndListParam.class,
-					Collections.<Class<? extends IQueryParameterType>> emptyList());
+					Collections.<Class<? extends IQueryParameterType>>emptyList());
-			break;
+				break;
-		case URI:
+			case URI:
-			binder = new QueryParameterAndBinder(UriAndListParam.class,
+				binder = new QueryParameterAndBinder(UriAndListParam.class,
-					Collections.<Class<? extends IQueryParameterType>> emptyList());
+					Collections.<Class<? extends IQueryParameterType>>emptyList());
-			break;
+				break;
-		case HAS:
+			case HAS:
-			binder = new QueryParameterAndBinder(HasAndListParam.class,
+				binder = new QueryParameterAndBinder(HasAndListParam.class,
-					Collections.<Class<? extends IQueryParameterType>> emptyList());
+					Collections.<Class<? extends IQueryParameterType>>emptyList());
-			break;
+				break;
 		}
 
 		// FIXME null access
@@ -108,7 +108,7 @@ public class ParameterUtil {
 	 * This is a utility method intended provided to help the JPA module.
 	 */
 	public static IQueryParameterAnd<?> parseQueryParams(FhirContext theContext, RuntimeSearchParam theParamDef,
-			String theUnqualifiedParamName, List<QualifiedParamList> theParameters) {
+																		  String theUnqualifiedParamName, List<QualifiedParamList> theParameters) {
 		RestSearchParameterTypeEnum paramType = theParamDef.getParamType();
 		return parseQueryParams(theContext, paramType, theUnqualifiedParamName, theParameters);
 	}
@@ -126,14 +126,14 @@ public class ParameterUtil {
 		for (int i = 0; i < theValue.length(); i++) {
 			char next = theValue.charAt(i);
 			switch (next) {
-			case '$':
+				case '$':
-			case ',':
+				case ',':
-			case '|':
+				case '|':
-			case '\\':
+				case '\\':
-				b.append('\\');
+					b.append('\\');
-				break;
+					break;
-			default:
+				default:
-				break;
+					break;
 			}
 			b.append(next);
 		}
@@ -207,7 +207,7 @@ public class ParameterUtil {
 
 	public static boolean isBindableIntegerType(Class<?> theClass) {
 		return Integer.class.isAssignableFrom(theClass)
-				|| IPrimitiveType.class.isAssignableFrom(theClass);
+			|| IPrimitiveType.class.isAssignableFrom(theClass);
 	}
 
 	public static String escapeAndJoinOrList(Collection<String> theValues) {
@@ -236,7 +236,7 @@ public class ParameterUtil {
 				if (value.charAt(0) == '"') {
 					eTagVersion = value.substring(1, value.length() - 1);
 				} else if (value.length() > 3 && value.charAt(0) == 'W' && value.charAt(1) == '/'
-						&& value.charAt(2) == '"') {
+					&& value.charAt(2) == '"') {
 					eTagVersion = value.substring(3, value.length() - 1);
 				} else {
 					eTagVersion = value;
@@ -262,16 +262,16 @@ public class ParameterUtil {
 
 			@Override
 			public void setValuesAsQueryTokens(FhirContext theContext, String theParamName,
-					QualifiedParamList theParameters) {
+														  QualifiedParamList theParameters) {
 				if (theParameters.isEmpty()) {
 					return;
 				}
 				if (theParameters.size() > 1) {
 					throw new IllegalArgumentException(
-							"Type " + theParam.getClass().getCanonicalName() + " does not support multiple values");
+						"Type " + theParam.getClass().getCanonicalName() + " does not support multiple values");
 				}
 				theParam.setValueAsQueryToken(theContext, theParamName, theParameters.getQualifier(),
-						theParameters.get(0));
+					theParameters.get(0));
 			}
 		};
 	}
@@ -351,13 +351,13 @@ public class ParameterUtil {
 					b.append(next);
 				} else {
 					switch (theValue.charAt(i + 1)) {
-					case '$':
+						case '$':
-					case ',':
+						case ',':
-					case '|':
+						case '|':
-					case '\\':
+						case '\\':
-						continue;
+							continue;
-					default:
+						default:
-						b.append(next);
+							b.append(next);
 					}
 				}
 			} else {

hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/dao/SearchBuilder.java

@@ -39,6 +39,7 @@ import ca.uhn.fhir.jpa.searchparam.MatchUrlService;
 import ca.uhn.fhir.jpa.searchparam.ResourceMetaParams;
 import ca.uhn.fhir.jpa.searchparam.SearchParameterMap;
 import ca.uhn.fhir.jpa.searchparam.registry.ISearchParamRegistry;
+import ca.uhn.fhir.jpa.searchparam.util.SourceParam;
 import ca.uhn.fhir.jpa.term.api.ITermReadSvc;
 import ca.uhn.fhir.jpa.term.VersionIndependentConcept;
 import ca.uhn.fhir.jpa.util.*;
@@ -861,19 +862,9 @@ public class SearchBuilder implements ISearchBuilder {
 		List<Predicate> codePredicates = new ArrayList<>();
 
 		for (IQueryParameterType nextParameter : theList) {
-			String nextParamValue = nextParameter.getValueAsQueryToken(myContext);
+			SourceParam sourceParameter = new SourceParam(nextParameter.getValueAsQueryToken(myContext));
-			int lastHashValueIndex = nextParamValue.lastIndexOf('#');
+			String sourceUri = sourceParameter.getSourceUri();
-			String sourceUri;
+			String requestId = sourceParameter.getRequestId();
-			String requestId;
-			if (lastHashValueIndex == -1) {
-				sourceUri = nextParamValue;
-				requestId = null;
-			} else {
-				sourceUri = nextParamValue.substring(0, lastHashValueIndex);
-				requestId = nextParamValue.substring(lastHashValueIndex + 1);
-			}
-			requestId = left(requestId, Constants.REQUEST_ID_LENGTH);
-
 			Predicate sourceUriPredicate = myBuilder.equal(join.get("mySourceUri"), sourceUri);
 			Predicate requestIdPredicate = myBuilder.equal(join.get("myRequestId"), requestId);
 			if (isNotBlank(sourceUri) && isNotBlank(requestId)) {

hapi-fhir-jpaserver-searchparam/src/main/java/ca/uhn/fhir/jpa/searchparam/MatchUrlService.java

@@ -93,16 +93,10 @@ public class MatchUrlService {
 						paramMap.setLastUpdated(p1);
 					}
 				}
-				continue;
+			} else if (Constants.PARAM_HAS.equals(nextParamName)) {
-			}
-
-			if (Constants.PARAM_HAS.equals(nextParamName)) {
 				IQueryParameterAnd<?> param = ParameterUtil.parseQueryParams(myContext, RestSearchParameterTypeEnum.HAS, nextParamName, paramList);
 				paramMap.add(nextParamName, param);
-				continue;
+			} else if (Constants.PARAM_COUNT.equals(nextParamName)) {
-			}
-
-			if (Constants.PARAM_COUNT.equals(nextParamName)) {
 				if (paramList.size() > 0 && paramList.get(0).size() > 0) {
 					String intString = paramList.get(0).get(0);
 					try {
@@ -111,16 +105,16 @@ public class MatchUrlService {
 						throw new InvalidRequestException("Invalid " + Constants.PARAM_COUNT + " value: " + intString);
 					}
 				}
-				continue;
+			} else if (ResourceMetaParams.RESOURCE_META_PARAMS.containsKey(nextParamName)) {
-			}
-
-			if (ResourceMetaParams.RESOURCE_META_PARAMS.containsKey(nextParamName)) {
 				if (isNotBlank(paramList.get(0).getQualifier()) && paramList.get(0).getQualifier().startsWith(".")) {
 					throw new InvalidRequestException("Invalid parameter chain: " + nextParamName + paramList.get(0).getQualifier());
 				}
 				IQueryParameterAnd<?> type = newInstanceAnd(nextParamName);
 				type.setValuesAsQueryTokens(myContext, nextParamName, (paramList));
 				paramMap.add(nextParamName, type);
+			} else if (Constants.PARAM_SOURCE.equals(nextParamName)) {
+				IQueryParameterAnd<?> param = ParameterUtil.parseQueryParams(myContext, RestSearchParameterTypeEnum.TOKEN, nextParamName, paramList);
+				paramMap.add(nextParamName, param);
 			} else if (nextParamName.startsWith("_")) {
 				// ignore these since they aren't search params (e.g. _sort)
 			} else {

hapi-fhir-jpaserver-searchparam/src/main/java/ca/uhn/fhir/jpa/searchparam/matcher/InMemoryResourceMatcher.java

@@ -27,6 +27,7 @@ import ca.uhn.fhir.jpa.searchparam.MatchUrlService;
 import ca.uhn.fhir.jpa.searchparam.SearchParameterMap;
 import ca.uhn.fhir.jpa.searchparam.extractor.ResourceIndexedSearchParams;
 import ca.uhn.fhir.jpa.searchparam.registry.ISearchParamRegistry;
+import ca.uhn.fhir.jpa.searchparam.util.SourceParam;
 import ca.uhn.fhir.model.api.IQueryParameterType;
 import ca.uhn.fhir.rest.api.Constants;
 import ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum;
@@ -35,6 +36,7 @@ import ca.uhn.fhir.rest.param.ParamPrefixEnum;
 import ca.uhn.fhir.rest.param.ReferenceParam;
 import ca.uhn.fhir.rest.param.StringParam;
 import ca.uhn.fhir.rest.server.exceptions.InvalidRequestException;
+import ca.uhn.fhir.util.MetaUtil;
 import ca.uhn.fhir.util.UrlUtil;
 import org.hl7.fhir.instance.model.api.IAnyResource;
 import org.hl7.fhir.instance.model.api.IBaseResource;
@@ -125,7 +127,6 @@ public class InMemoryResourceMatcher {
 
 		switch (theParamName) {
 			case IAnyResource.SP_RES_ID:
-
 				return InMemoryMatchResult.fromBoolean(matchIdsAndOr(theAndOrParams, theResource));
 
 			case IAnyResource.SP_RES_LANGUAGE:
@@ -133,16 +134,38 @@ public class InMemoryResourceMatcher {
 			case Constants.PARAM_TAG:
 			case Constants.PARAM_PROFILE:
 			case Constants.PARAM_SECURITY:
-
 				return InMemoryMatchResult.unsupportedFromParameterAndReason(theParamName, InMemoryMatchResult.PARAM);
-
+			case Constants.PARAM_SOURCE:
+				return InMemoryMatchResult.fromBoolean(matchSourcesAndOr(theAndOrParams, theResource));
 			default:
-
-
 				return matchResourceParam(theParamName, theAndOrParams, theSearchParams, resourceName, paramDef);
 		}
 	}
 
+	private boolean matchSourcesAndOr(List<List<IQueryParameterType>> theAndOrParams, IBaseResource theResource) {
+		if (theResource == null) {
+			return true;
+		}
+		return theAndOrParams.stream().allMatch(nextAnd -> matchSourcesOr(nextAnd, theResource));
+	}
+
+	private boolean matchSourcesOr(List<IQueryParameterType> theOrParams, IBaseResource theResource) {
+		return theOrParams.stream().anyMatch(param -> matchSource(param, theResource));
+	}
+
+	private boolean matchSource(IQueryParameterType theSourceParam, IBaseResource theResource) {
+		SourceParam paramSource = new SourceParam(theSourceParam.getValueAsQueryToken(myFhirContext));
+		SourceParam resourceSource = new SourceParam(MetaUtil.getSource(myFhirContext, theResource.getMeta()));
+		boolean matches = true;
+		if (paramSource.getSourceUri() != null) {
+			matches = paramSource.getSourceUri().equals(resourceSource.getSourceUri());
+		}
+		if (paramSource.getRequestId() != null) {
+			matches &= paramSource.getRequestId().equals(resourceSource.getRequestId());
+		}
+		return matches;
+	}
+
 	private boolean matchIdsAndOr(List<List<IQueryParameterType>> theAndOrParams, IBaseResource theResource) {
 		if (theResource == null) {
 			return true;
@@ -151,9 +174,6 @@ public class InMemoryResourceMatcher {
 	}
 
 	private boolean matchIdsOr(List<IQueryParameterType> theOrParams, IBaseResource theResource) {
-		if (theResource == null) {
-			return true;
-		}
 		return theOrParams.stream().anyMatch(param -> param instanceof StringParam && matchId(((StringParam) param).getValue(), theResource.getIdElement()));
 	}
 

hapi-fhir-jpaserver-searchparam/src/main/java/ca/uhn/fhir/jpa/searchparam/util/SourceParam.java

@@ -0,0 +1,62 @@
+package ca.uhn.fhir.jpa.searchparam.util;
+
+import ca.uhn.fhir.rest.api.Constants;
+
+import static org.apache.commons.lang3.StringUtils.left;
+
+/*
+ * #%L
+ * HAPI FHIR - Core Library
+ * %%
+ * Copyright (C) 2014 - 2019 University Health Network
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+/**
+ * Model of the _source parameter
+ */
+public class SourceParam {
+
+	private static final long serialVersionUID = 1L;
+	private final String myParameterValue;
+	private final String mySourceUri;
+	private final String myRequestId;
+
+	public SourceParam(String theParameterValue) {
+		myParameterValue = theParameterValue;
+		String requestId;
+		int lastHashValueIndex = theParameterValue.lastIndexOf('#');
+		if (lastHashValueIndex == -1) {
+			mySourceUri = theParameterValue;
+			requestId = null;
+		} else {
+			if (lastHashValueIndex == 0) {
+				mySourceUri = null;
+			} else {
+				mySourceUri = theParameterValue.substring(0, lastHashValueIndex);
+			}
+			requestId = theParameterValue.substring(lastHashValueIndex + 1);
+		}
+		myRequestId = left(requestId, Constants.REQUEST_ID_LENGTH);
+	}
+
+	public String getSourceUri() {
+		return mySourceUri;
+	}
+
+	public String getRequestId() {
+		return myRequestId;
+	}
+}

hapi-fhir-jpaserver-searchparam/src/test/java/ca/uhn/fhir/jpa/searchparam/matcher/InMemoryResourceMatcherR5Test.java

@@ -7,6 +7,7 @@ import ca.uhn.fhir.jpa.searchparam.MatchUrlService;
 import ca.uhn.fhir.jpa.searchparam.extractor.ResourceIndexedSearchParams;
 import ca.uhn.fhir.jpa.searchparam.registry.ISearchParamRegistry;
 import ca.uhn.fhir.model.primitive.BaseDateTimeDt;
+import ca.uhn.fhir.rest.api.Constants;
 import ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum;
 import ca.uhn.fhir.rest.param.ParamPrefixEnum;
 import ca.uhn.fhir.rest.param.TokenParamModifier;
@@ -38,10 +39,12 @@ public class InMemoryResourceMatcherR5Test {
 	private static final String EARLY_DATE = "1965-08-09";
 	private static final String LATE_DATE = "2000-06-29";
 	public static final String OBSERVATION_CODE = "MATCH";
+	private static final String SOURCE_URI = "urn:source:0";
+	private static final String REQUEST_ID = "a_request_id";
+	private static final String TEST_SOURCE = SOURCE_URI + "#" + REQUEST_ID;
 
 	@Autowired
-	private
+	private InMemoryResourceMatcher myInMemoryResourceMatcher;
-	InMemoryResourceMatcher myInMemoryResourceMatcher;
 
 	@MockBean
 	ISearchParamRegistry mySearchParamRegistry;
@@ -81,6 +84,7 @@ public class InMemoryResourceMatcherR5Test {
 		when(mySearchParamRegistry.getActiveSearchParam("Observation", "encounter")).thenReturn(encSearchParam);
 
 		myObservation = new Observation();
+		myObservation.getMeta().setSource(TEST_SOURCE);
 		myObservation.setEffective(new DateTimeType(OBSERVATION_DATE));
 		CodeableConcept codeableConcept = new CodeableConcept();
 		codeableConcept.addCoding().setCode(OBSERVATION_CODE);
@@ -88,6 +92,26 @@ public class InMemoryResourceMatcherR5Test {
 		mySearchParams = extractDateSearchParam(myObservation);
 	}
 
+	@Test
+	public void testSupportedSource() {
+		{
+			InMemoryMatchResult result = myInMemoryResourceMatcher.match(Constants.PARAM_SOURCE + "=" + TEST_SOURCE, myObservation, mySearchParams);
+			assertTrue(result.matched());
+		}
+		{
+			InMemoryMatchResult result = myInMemoryResourceMatcher.match(Constants.PARAM_SOURCE + "=" + SOURCE_URI, myObservation, mySearchParams);
+			assertTrue(result.matched());
+		}
+		{
+			InMemoryMatchResult result = myInMemoryResourceMatcher.match(Constants.PARAM_SOURCE + "=" + REQUEST_ID, myObservation, mySearchParams);
+			assertFalse(result.matched());
+		}
+		{
+			InMemoryMatchResult result = myInMemoryResourceMatcher.match(Constants.PARAM_SOURCE + "=#" + REQUEST_ID, myObservation, mySearchParams);
+			assertTrue(result.matched());
+		}
+	}
+
 	@Test
 	public void testUnsupportedChained() {
 		InMemoryMatchResult result = myInMemoryResourceMatcher.match("encounter.class=FOO", myObservation, mySearchParams);