Introduce hibernate envers, use it only for MdmLink, disable it for n…

…ow, add to MdmLink Dao and unit test revisions. (#4615) * First commit with new maven deps for envers and stubbed changelist. * Add repositoryFactoryBeanClass = EnversRevisionRepositoryFactoryBean.class to BaseAppCtxPersistence. Comment it out in JpaConfig. Add constant for hibernate.integration.envers.enabled. Hard-code envers to false. App starts without error. Basic smoke testing for MpmLink update works. * Add mdmLink code to retrieve envers history and unit test it. * Initial code to handle envers from HapiFhirEnversRevision along with a custom extension of the revision/REVINFO entity. * Add changelist and tweak table/sequence/field names and clean up the HapiFhirJpaMigrationTasks method. * Fix some unit test failures and address TODOs. * Ensure hard-coded deactivation of envers is overridden by unit tests. * Remove commented-out code. * Address code review comments. * Remove sysout traces. * Tweaks to poms with comments explaining why I left the versions in the plugin dependencies. Get rid of a duplicate envers dependency. * Bump hapi-fhir version to 6.5.5-SNAPSHOT. * Disable intermittently failing test: PartitionedSubscriptionTriggeringR4Test.testCreateSubscriptionInPartitionAndResourceInDifferentPartition * Try disabling Batch2CoordinatorIT failing test and see if branch pipeline passes. * Add back hapi-fhir-validation-resources-r4b to hapi-fhir-jpaserver-base pom.xml. * Bump hapi-fhir to 6.5.6-SNAPSHOT. * Bump rest of hapi-fhir to 6.5.6-SNAPSHOT. * Fix compile error on Batch2CoordinatorIT. * Change revision ID column from integer to long in both the revision entity and the migration tasks. Fix a bug with the migration tasks having the wrong name for the timestamp column. * Fix interface in MongoDB to return Long for the revision ID instead of Int. Implement TINYINT for all supported database products. Keep TARGET_TYPE column at 40 instead of 100 for now since otherwise the schema migration test will fail. Also, don't try to rename the foreign key or the schema migration test will fail.
hapifhir · Mar 14, 2023 · ea8b68f · ea8b68f
1 parent fdf7450
commit ea8b68f
Show file tree

Hide file tree

Showing 94 changed files with 355 additions and 80 deletions.
diff --git a/hapi-deployable-pom/pom.xml b/hapi-deployable-pom/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		 <groupId>ca.uhn.hapi.fhir</groupId>
 		 <artifactId>hapi-fhir</artifactId>
-		 <version>6.5.5-SNAPSHOT</version>
+		 <version>6.5.6-SNAPSHOT</version>
 		 <relativePath>../pom.xml</relativePath>
 	 </parent>
 

diff --git a/hapi-fhir-android/pom.xml b/hapi-fhir-android/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-deployable-pom</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../hapi-deployable-pom/pom.xml</relativePath>
 	</parent>
 

diff --git a/hapi-fhir-base/pom.xml b/hapi-fhir-base/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-deployable-pom</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../hapi-deployable-pom/pom.xml</relativePath>
 	</parent>
 

diff --git a/hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/api/Constants.java b/hapi-fhir-base/src/main/java/ca/uhn/fhir/rest/api/Constants.java
@@ -312,6 +312,11 @@ public class Constants {
  	 */
 	public static final int UUID_LENGTH = 36;
 
+	/**
+	 * Application configuration key used to enable or disable Hibernate Envers.
+	 */
+	public static final String HIBERNATE_INTEGRATION_ENVERS_ENABLED = "hibernate.integration.envers.enabled";
+
     static {
 		CHARSET_UTF8 = StandardCharsets.UTF_8;
 		CHARSET_US_ASCII = StandardCharsets.ISO_8859_1;

diff --git a/hapi-fhir-bom/pom.xml b/hapi-fhir-bom/pom.xml
@@ -4,14 +4,14 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>ca.uhn.hapi.fhir</groupId>
 	<artifactId>hapi-fhir-bom</artifactId>
-	<version>6.5.5-SNAPSHOT</version>
+	<version>6.5.6-SNAPSHOT</version>
 	<packaging>pom</packaging>
 	<name>HAPI FHIR BOM</name>
 
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-deployable-pom</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../hapi-deployable-pom/pom.xml</relativePath>
 	</parent>
 

diff --git a/hapi-fhir-checkstyle/pom.xml b/hapi-fhir-checkstyle/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-fhir</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../pom.xml</relativePath>
 	</parent>
 

diff --git a/hapi-fhir-cli/hapi-fhir-cli-api/pom.xml b/hapi-fhir-cli/hapi-fhir-cli-api/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-deployable-pom</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../../hapi-deployable-pom/pom.xml</relativePath>
 	</parent>
 

diff --git a/hapi-fhir-cli/hapi-fhir-cli-app/pom.xml b/hapi-fhir-cli/hapi-fhir-cli-app/pom.xml
@@ -6,7 +6,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-fhir-cli</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../pom.xml</relativePath>
 	</parent>
 

diff --git a/hapi-fhir-cli/hapi-fhir-cli-jpaserver/pom.xml b/hapi-fhir-cli/hapi-fhir-cli-jpaserver/pom.xml
@@ -6,7 +6,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-deployable-pom</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../../hapi-deployable-pom</relativePath>
 	</parent>
 

diff --git a/hapi-fhir-cli/pom.xml b/hapi-fhir-cli/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-fhir</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../pom.xml</relativePath>
 	</parent>
 

diff --git a/hapi-fhir-client-okhttp/pom.xml b/hapi-fhir-client-okhttp/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-deployable-pom</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../hapi-deployable-pom/pom.xml</relativePath>
 	</parent>
 

diff --git a/hapi-fhir-client/pom.xml b/hapi-fhir-client/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-deployable-pom</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../hapi-deployable-pom/pom.xml</relativePath>
 	</parent>
 

diff --git a/hapi-fhir-converter/pom.xml b/hapi-fhir-converter/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-deployable-pom</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../hapi-deployable-pom/pom.xml</relativePath>
 	</parent>
 

diff --git a/hapi-fhir-dist/pom.xml b/hapi-fhir-dist/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-fhir</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../pom.xml</relativePath>
 	</parent>
 

diff --git a/hapi-fhir-docs/pom.xml b/hapi-fhir-docs/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-deployable-pom</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../hapi-deployable-pom/pom.xml</relativePath>
 	</parent>
 

diff --git a/...sources/ca/uhn/hapi/fhir/changelog/6_6_0/4632-mdm-link-history-hibernate-envers-only.yaml b/...sources/ca/uhn/hapi/fhir/changelog/6_6_0/4632-mdm-link-history-hibernate-envers-only.yaml
@@ -0,0 +1,4 @@
+---
+type: add
+issue: 4632
+title: "Add support for MdmLink history in the data model.  MdmLink history will be stored in the new mdm_link_aud table."
diff --git a/hapi-fhir-jacoco/pom.xml b/hapi-fhir-jacoco/pom.xml
@@ -11,7 +11,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-deployable-pom</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../hapi-deployable-pom/pom.xml</relativePath>
 	</parent>
 

diff --git a/hapi-fhir-jaxrsserver-base/pom.xml b/hapi-fhir-jaxrsserver-base/pom.xml
@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-deployable-pom</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../hapi-deployable-pom/pom.xml</relativePath>
 	</parent>
 

diff --git a/hapi-fhir-jpa/pom.xml b/hapi-fhir-jpa/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-deployable-pom</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../hapi-deployable-pom/pom.xml</relativePath>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>

diff --git a/.../src/main/java/ca/uhn/fhir/jpa/config/HapiFhirLocalContainerEntityManagerFactoryBean.java b/.../src/main/java/ca/uhn/fhir/jpa/config/HapiFhirLocalContainerEntityManagerFactoryBean.java
@@ -20,6 +20,7 @@
  * #L%
  */
 
+import ca.uhn.fhir.rest.api.Constants;
 import com.google.common.base.Strings;
 import org.hibernate.cfg.AvailableSettings;
 import org.hibernate.query.criteria.LiteralHandlingMode;
@@ -50,6 +51,11 @@ public HapiFhirLocalContainerEntityManagerFactoryBean(ConfigurableListableBeanFa
 	public Map<String, Object> getJpaPropertyMap() {
 		Map<String, Object> retVal = super.getJpaPropertyMap();
 
+		// TODO: LD:  expose configuration for this in a future MR
+		if (!retVal.containsKey(Constants.HIBERNATE_INTEGRATION_ENVERS_ENABLED)) {
+			retVal.put(Constants.HIBERNATE_INTEGRATION_ENVERS_ENABLED, false);
+		}
+
 		// SOMEDAY these defaults can be set in the constructor.  setJpaProperties does a merge.
 		if (!retVal.containsKey(AvailableSettings.CRITERIA_LITERAL_HANDLING_MODE)) {
 			retVal.put(AvailableSettings.CRITERIA_LITERAL_HANDLING_MODE, LiteralHandlingMode.BIND);

diff --git a/hapi-fhir-jpaserver-base/pom.xml b/hapi-fhir-jpaserver-base/pom.xml
@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>ca.uhn.hapi.fhir</groupId>
 		<artifactId>hapi-deployable-pom</artifactId>
-		<version>6.5.5-SNAPSHOT</version>
+		<version>6.5.6-SNAPSHOT</version>
 		<relativePath>../hapi-deployable-pom/pom.xml</relativePath>
 	</parent>
 
@@ -345,6 +345,14 @@
 			<groupId>org.hibernate.search</groupId>
 			<artifactId>hibernate-search-backend-elasticsearch-aws</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>org.hibernate</groupId>
+			<artifactId>hibernate-envers</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.springframework.data</groupId>
+			<artifactId>spring-data-envers</artifactId>
+		</dependency>
 		<dependency>
 			<groupId>org.apache.lucene</groupId>
 			<artifactId>lucene-analyzers-phonetic</artifactId>
@@ -476,6 +484,22 @@
 						<artifactId>hibernate-core</artifactId>
 						<version>${hibernate_version}</version>
 					</dependency>
+					<dependency>
+						<groupId>org.hibernate</groupId>
+						<artifactId>hibernate-envers</artifactId>
+						<!-- N.B. Maven reacts badly if we omit the version for plugin dependencies, despite being defined in the parent pom's dependencyManagement section -->
+						<version>${hibernate_version}</version>
+					</dependency>
+					<dependency>
+						<groupId>javax.xml.bind</groupId>
+						<artifactId>jaxb-api</artifactId>
+						<version>${jaxb_api_version}</version>
+					</dependency>
+					<dependency>
+						<groupId>com.sun.xml.bind</groupId>
+						<artifactId>jaxb-impl</artifactId>
+						<version>${jaxb_api_version}</version>
+					</dependency>
 				</dependencies>
 			</plugin>
 			<plugin>

diff --git a/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/config/JpaConfig.java b/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/config/JpaConfig.java
@@ -168,6 +168,7 @@
 import org.springframework.context.annotation.Primary;
 import org.springframework.context.annotation.Scope;
 import org.springframework.core.task.AsyncTaskExecutor;
+import org.springframework.data.envers.repository.support.EnversRevisionRepositoryFactoryBean;
 import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
 import org.springframework.scheduling.TaskScheduler;
 import org.springframework.scheduling.concurrent.ConcurrentTaskScheduler;
@@ -199,7 +200,8 @@
  */
 
 @Configuration
-@EnableJpaRepositories(basePackages = "ca.uhn.fhir.jpa.dao.data")
+// repositoryFactoryBeanClass: EnversRevisionRepositoryFactoryBean is needed primarily for unit testing
+@EnableJpaRepositories(basePackages = "ca.uhn.fhir.jpa.dao.data", repositoryFactoryBeanClass = EnversRevisionRepositoryFactoryBean.class)
 @Import({
 	BeanPostProcessorConfig.class,
 	TermCodeSystemConfig.class,

diff --git a/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/dao/data/IMdmLinkJpaRepository.java b/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/dao/data/IMdmLinkJpaRepository.java
@@ -26,6 +26,7 @@
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.data.jpa.repository.Modifying;
 import org.springframework.data.jpa.repository.Query;
+import org.springframework.data.repository.history.RevisionRepository;
 import org.springframework.data.repository.query.Param;
 import org.springframework.stereotype.Repository;
 
@@ -34,7 +35,7 @@
 import java.util.Optional;
 
 @Repository
-public interface IMdmLinkJpaRepository extends JpaRepository<MdmLink, Long>, IHapiFhirJpaRepository {
+public interface IMdmLinkJpaRepository extends RevisionRepository<MdmLink, Long, Long>,JpaRepository<MdmLink, Long>, IHapiFhirJpaRepository {
 	@Modifying
 	@Query("DELETE FROM MdmLink f WHERE myGoldenResourcePid = :pid OR mySourcePid = :pid")
 	int deleteWithAnyReferenceToPid(@Param("pid") Long thePid);

diff --git a/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/dao/mdm/MdmLinkDaoJpaImpl.java b/hapi-fhir-jpaserver-base/src/main/java/ca/uhn/fhir/jpa/dao/mdm/MdmLinkDaoJpaImpl.java
@@ -33,17 +33,21 @@
 import ca.uhn.fhir.mdm.api.paging.MdmPageRequest;
 import ca.uhn.fhir.mdm.dao.IMdmLinkDao;
 import ca.uhn.fhir.mdm.model.MdmPidTuple;
+import ca.uhn.fhir.rest.api.Constants;
 import ca.uhn.fhir.rest.api.SortOrderEnum;
 import ca.uhn.fhir.rest.server.exceptions.UnprocessableEntityException;
 import org.apache.commons.collections4.CollectionUtils;
 import org.apache.commons.collections4.ListUtils;
 import org.hl7.fhir.instance.model.api.IIdType;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.data.domain.Example;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.PageImpl;
 import org.springframework.data.domain.PageRequest;
 import org.springframework.data.domain.Pageable;
+import org.springframework.data.history.Revisions;
 
 import javax.persistence.EntityManager;
 import javax.persistence.TypedQuery;
@@ -71,6 +75,8 @@
 import static ca.uhn.fhir.mdm.api.MdmQuerySearchParameters.SOURCE_PID_NAME;
 
 public class MdmLinkDaoJpaImpl implements IMdmLinkDao<JpaPid, MdmLink> {
+	private static final Logger ourLog = LoggerFactory.getLogger(MdmLinkDaoJpaImpl.class);
+
 	@Autowired
 	IMdmLinkJpaRepository myMdmLinkDao;
 	@Autowired
@@ -300,4 +306,14 @@ public void deleteLinksWithAnyReferenceToPids(List<JpaPid> theResourcePersistent
 			myMdmLinkDao.deleteLinksWithAnyReferenceToPids(chunk);
 		}
 	}
+
+	@Override
+	public Revisions<Long, MdmLink> findHistory(JpaPid theMdmLinkPid) {
+		// TODO:  LD:  future MR for MdmdLink History return some other object than Revisions, like a Map of List, Pageable, etc?
+		final Revisions<Long, MdmLink> revisions = myMdmLinkDao.findRevisions(theMdmLinkPid.getId());
+
+		revisions.forEach(revision -> ourLog.debug("MdmLink revision: {}", revision));
+
+		return revisions;
+	}
 }