ca.uhn.fhir.jpa.searchparam.registry.JpaSearchParamCache Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * HAPI FHIR JPA - Search Parameters
 * %%
 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
 * %%
 * 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%
 */
package ca.uhn.fhir.jpa.searchparam.registry;

import ca.uhn.fhir.context.ComboSearchParamType;
import ca.uhn.fhir.context.RuntimeSearchParam;
import ca.uhn.fhir.context.phonetic.IPhoneticEncoder;
import ca.uhn.fhir.interceptor.api.HookParams;
import ca.uhn.fhir.interceptor.api.IInterceptorService;
import ca.uhn.fhir.interceptor.api.Pointcut;
import ca.uhn.fhir.interceptor.model.RequestPartitionId;
import ca.uhn.fhir.jpa.model.config.PartitionSettings;
import ca.uhn.fhir.jpa.model.search.StorageProcessingMessage;
import ca.uhn.fhir.jpa.model.util.SearchParamHash;
import ca.uhn.fhir.rest.api.Constants;
import ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum;
import ca.uhn.fhir.rest.api.server.RequestDetails;
import ca.uhn.fhir.rest.server.servlet.ServletRequestDetails;
import ca.uhn.fhir.rest.server.util.IndexedSearchParam;
import ca.uhn.fhir.rest.server.util.ResourceSearchParams;
import org.hl7.fhir.instance.model.api.IIdType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.TreeSet;
import java.util.stream.Collectors;

import static ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum.DATE;
import static ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum.NUMBER;
import static ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum.QUANTITY;
import static ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum.REFERENCE;
import static ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum.SPECIAL;
import static ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum.STRING;
import static ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum.TOKEN;
import static ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum.URI;
import static org.apache.commons.lang3.StringUtils.isNotBlank;

public class JpaSearchParamCache {
	private static final Logger ourLog = LoggerFactory.getLogger(JpaSearchParamCache.class);

	private static final List SUPPORTED_INDEXED_SEARCH_PARAMS =
			List.of(SPECIAL, DATE, NUMBER, QUANTITY, STRING, TOKEN, URI, REFERENCE);

	volatile Map> myActiveComboSearchParams = Collections.emptyMap();
	volatile Map, List>> myActiveParamNamesToComboSearchParams =
			Collections.emptyMap();
	volatile Map myHashIdentityToIndexedSearchParams = Collections.emptyMap();

	public List getActiveComboSearchParams(String theResourceName) {
		List retval = myActiveComboSearchParams.get(theResourceName);
		if (retval == null) {
			retval = Collections.emptyList();
		}
		return retval;
	}

	public List getActiveComboSearchParams(
			String theResourceName, ComboSearchParamType theParamType) {
		return getActiveComboSearchParams(theResourceName).stream()
				.filter(param -> Objects.equals(theParamType, param.getComboSearchParamType()))
				.collect(Collectors.toList());
	}

	public Optional getActiveComboSearchParamById(String theResourceName, IIdType theId) {
		IIdType idToFind = theId.toUnqualifiedVersionless();
		return getActiveComboSearchParams(theResourceName).stream()
				.filter((param) -> Objects.equals(idToFind, param.getIdUnqualifiedVersionless()))
				.findFirst();
	}

	public List getActiveComboSearchParams(String theResourceName, Set theParamNames) {
		Map, List> paramNamesToParams =
				myActiveParamNamesToComboSearchParams.get(theResourceName);
		if (paramNamesToParams == null) {
			return Collections.emptyList();
		}

		List retVal = paramNamesToParams.get(theParamNames);
		if (retVal == null) {
			retVal = Collections.emptyList();
		}
		return Collections.unmodifiableList(retVal);
	}

	public Optional getIndexedSearchParamByHashIdentity(Long theHashIdentity) {
		return Optional.ofNullable(myHashIdentityToIndexedSearchParams.get(theHashIdentity));
	}

	void populateActiveSearchParams(
			IInterceptorService theInterceptorBroadcaster,
			IPhoneticEncoder theDefaultPhoneticEncoder,
			RuntimeSearchParamCache theActiveSearchParams) {
		Map> resourceNameToComboSearchParams = new HashMap<>();
		Map, List>> activeParamNamesToComboSearchParams = new HashMap<>();

		Map idToRuntimeSearchParam = new HashMap<>();
		List jpaSearchParams = new ArrayList<>();
		Map hashIdentityToIndexedSearchParams = new HashMap<>();

		/*
		 * Loop through parameters and find JPA params
		 */
		for (String theResourceName : theActiveSearchParams.getResourceNameKeys()) {
			ResourceSearchParams searchParams = theActiveSearchParams.getSearchParamMap(theResourceName);
			List comboSearchParams =
					resourceNameToComboSearchParams.computeIfAbsent(theResourceName, k -> new ArrayList<>());
			Collection nextSearchParamsForResourceName = searchParams.values();

			ourLog.trace("Resource {} has {} params", theResourceName, searchParams.size());

			for (RuntimeSearchParam nextCandidate : nextSearchParamsForResourceName) {

				ourLog.trace(
						"Resource {} has parameter {} with ID {}",
						theResourceName,
						nextCandidate.getName(),
						nextCandidate.getId());

				if (nextCandidate.getId() != null) {
					idToRuntimeSearchParam.put(
							nextCandidate.getId().toUnqualifiedVersionless().getValue(), nextCandidate);
				}
				if (isNotBlank(nextCandidate.getUri())) {
					idToRuntimeSearchParam.put(nextCandidate.getUri(), nextCandidate);
				}

				jpaSearchParams.add(nextCandidate);
				if (nextCandidate.getComboSearchParamType() != null) {
					comboSearchParams.add(nextCandidate);
				}

				setPhoneticEncoder(theDefaultPhoneticEncoder, nextCandidate);
				populateIndexedSearchParams(theResourceName, nextCandidate, hashIdentityToIndexedSearchParams);
			}
		}

		ourLog.trace("Have {} search params loaded", idToRuntimeSearchParam.size());

		Set haveSeen = new HashSet<>();
		for (RuntimeSearchParam next : jpaSearchParams) {
			if (next.getId() != null
					&& !haveSeen.add(next.getId().toUnqualifiedVersionless().getValue())) {
				continue;
			}

			Set paramNames = new TreeSet<>();
			for (RuntimeSearchParam.Component nextComponent : next.getComponents()) {
				String nextRef = nextComponent.getReference();
				RuntimeSearchParam componentTarget = idToRuntimeSearchParam.get(nextRef);
				if (componentTarget != null) {
					paramNames.add(componentTarget.getName());
				} else {
					String message = "Search parameter " + next + " refers to unknown component " + nextRef
							+ ", ignoring this parameter";
					ourLog.warn(message);

					// Interceptor broadcast: JPA_PERFTRACE_WARNING
					HookParams params = new HookParams()
							.add(RequestDetails.class, null)
							.add(ServletRequestDetails.class, null)
							.add(StorageProcessingMessage.class, new StorageProcessingMessage().setMessage(message));
					theInterceptorBroadcaster.callHooks(Pointcut.JPA_PERFTRACE_WARNING, params);
				}
			}

			if (next.getComboSearchParamType() != null) {
				for (String nextBase : next.getBase()) {
					activeParamNamesToComboSearchParams.computeIfAbsent(nextBase, v -> new HashMap<>());
					activeParamNamesToComboSearchParams
							.get(nextBase)
							.computeIfAbsent(paramNames, t -> new ArrayList<>());
					activeParamNamesToComboSearchParams
							.get(nextBase)
							.get(paramNames)
							.add(next);
				}
			}
		}

		ourLog.info("Have {} unique search params", activeParamNamesToComboSearchParams.size());

		myActiveComboSearchParams = resourceNameToComboSearchParams;
		myActiveParamNamesToComboSearchParams = activeParamNamesToComboSearchParams;
		myHashIdentityToIndexedSearchParams = hashIdentityToIndexedSearchParams;
	}

	void setPhoneticEncoder(IPhoneticEncoder theDefaultPhoneticEncoder, RuntimeSearchParam searchParam) {
		if ("phonetic".equals(searchParam.getName())) {
			ourLog.debug(
					"Setting search param {} on {} phonetic encoder to {}",
					searchParam.getName(),
					searchParam.getPath(),
					theDefaultPhoneticEncoder == null ? "null" : theDefaultPhoneticEncoder.name());
			searchParam.setPhoneticEncoder(theDefaultPhoneticEncoder);
		}
	}

	private void populateIndexedSearchParams(
			String theResourceName,
			RuntimeSearchParam theRuntimeSearchParam,
			Map theHashIdentityToIndexedSearchParams) {

		if (SUPPORTED_INDEXED_SEARCH_PARAMS.contains(theRuntimeSearchParam.getParamType())) {
			addIndexedSearchParam(
					theResourceName, theHashIdentityToIndexedSearchParams, theRuntimeSearchParam.getName());
			// handle token search parameters with :of-type modifier
			if (theRuntimeSearchParam.getParamType() == TOKEN) {
				addIndexedSearchParam(
						theResourceName,
						theHashIdentityToIndexedSearchParams,
						theRuntimeSearchParam.getName() + Constants.PARAMQUALIFIER_TOKEN_OF_TYPE);
			}
			// handle Uplifted Ref Chain Search Parameters
			theRuntimeSearchParam.getUpliftRefchainCodes().stream()
					.map(urCode -> String.format("%s.%s", theRuntimeSearchParam.getName(), urCode))
					.forEach(urSpName ->
							addIndexedSearchParam(theResourceName, theHashIdentityToIndexedSearchParams, urSpName));
		}
	}

	private void addIndexedSearchParam(
			String theResourceName,
			Map theHashIdentityToIndexedSearchParams,
			String theSpName) {
		Long hashIdentity = SearchParamHash.hashSearchParam(
				new PartitionSettings(), RequestPartitionId.defaultPartition(), theResourceName, theSpName);
		theHashIdentityToIndexedSearchParams.put(hashIdentity, new IndexedSearchParam(theSpName, theResourceName));
	}
}