Archiving JPA entity causes unnecessary need to set up archive table

[cmetzlerhg]

With version 1.3 there is a new completion-mode value, which should be UPDATE by default. If the property is not set at all, the completion mode seems to be ARCHIVE which would require to introduce a new table and eventually updating the logic to delete archived events.

Quick workaround is setting spring.modulith.events.completion-mode to the desired mode in the application.properties.

[odrotbohm]

Again: can you please provide more details on what erroneous behavior you see and what you expect? “…seems to be ARCHIVE” is not something we can reasonably act upon. How do you deduce that the archive mode is active?

Generally speaking, the CompletionMode is detected based on CompletionMode.from(Environment) and defaults to CompletionMode.UPDATE.

spring-modulith/spring-modulith-events/spring-modulith-events-core/src/main/java/org/springframework/modulith/events/support/CompletionMode.java

Lines 49 to 62 in 3b608e9

	/**
	* Looks up the {@link CompletionMode} from the given environment or uses {@link #UPDATE} as default.
	*
	* @param environment must not be {@literal null}.
	* @return will never be {@literal null}.
	*/
	public static CompletionMode from(Environment environment) {
	Assert.notNull(environment, "Environment must not be null!");
	var result = environment.getProperty(PROPERTY, CompletionMode.class);
	return result == null ? CompletionMode.UPDATE : result;
	}

[cmetzlerhg]

@odrotbohm when I update the dependency to version 1.3.0 I get the following exception:

09:23:17.949 [main] ERROR o.s.boot.SpringApplication - [] Application run failed 
org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'entityManagerFactory' defined in class path resource [org/springframework/boot/autoconfigure/orm/jpa/HibernateJpaConfiguration.class]: [PersistenceUnit: default] Unable to build Hibernate SessionFactory; nested exception is org.hibernate.tool.schema.spi.SchemaManagementException: Schema-validation: missing table [event_publication_archive]

But you're correct, even if I set the property spring.modulith.events.completion-mode to update Hibernate still complains about the missing table.

[cmetzlerhg]

I will close the ticket, because my assumption was wrong.

[cmetzlerhg]

@odrotbohm let me know, if you need a new ticket. I think this is related to org.springframework.modulith:spring-modulith-starter-jpa when setting spring.jpa.hibernate.ddl-auto=validate and using Flyway or similar tools to manually create the required tables. Adding a new migration to create the new table event_publication_archive fixes the issue.

[odrotbohm]

Not so fast. Your high-level observation was incomplete, but you identified an actual problem. :) Here's what I think is happening:

Spring Modulith 1.3 introduced a new JPA entity ArchivedJpaEventPublication mapped to the event_publication_archive table by default. It's located in the same package as DefaultJpaEventPublication, thus found when Spring Boot is scanning for entity types and registered with the EntityManagerFactory. A Hibernate, set up to verify the database schema on startup (spring.jpa.hibernate.ddl-auto=validate), will verify that all tables for all entities registered exist and thus report the archive table missing, independent of which completion mode is configured.

We should try to find a way to only make the archive entity known to Spring Boot if the completion mode is indeed set to archive.

[odrotbohm]

This should be fixed in the latest snapshots (also 1.3.1 ones).