Provide ObjectMapper to engine via custom interface to avoid multiple…

… ObjectMapper beans
NitorCreations · Aug 23, 2023 · 5f3a550 · 5f3a550
1 parent fefebbd
commit 5f3a550
Show file tree

Hide file tree

Showing 14 changed files with 31 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -59,6 +59,8 @@
   - Remove obsolete mysql legacy ddl sql scripts.
   - Include generated mariadb.create.ddl.sql in sources.jar.
   - Added tests against Oracle now that there is a working docker image of Oracle XE
+- `nflow-rest-api`
+  - POTENTIALLY BREAKING CHANGE: Remove `@Primary` annotation from `nflowRestObjectMapper` in `RestConfiguration` to allow overriding default mapper. Spring Boot applications may need to define the mapper explicitly now.
 - `nflow-metrics`
   - export the nflow.database.type as a metric
 - `nflow-netty`

diff --git a/nflow-engine/src/main/java/io/nflow/engine/config/EngineConfiguration.java b/nflow-engine/src/main/java/io/nflow/engine/config/EngineConfiguration.java
@@ -4,6 +4,7 @@
 import static java.lang.Runtime.getRuntime;
 
 import java.util.concurrent.ThreadFactory;
+import java.util.function.Supplier;
 
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
@@ -26,6 +27,8 @@
 @ComponentScan("io.nflow.engine")
 public class EngineConfiguration {
 
+  public interface EngineObjectMapperSupplier extends Supplier<ObjectMapper> {}
+
   /**
    * Creates a workflow instance executor for processing workflow instances.
    *
@@ -62,11 +65,11 @@ public ThreadFactory nflowThreadFactory() {
    */
   @Bean
   @NFlow
-  public ObjectMapper nflowObjectMapper() {
+  public EngineObjectMapperSupplier nflowObjectMapper() {
     ObjectMapper mapper = new ObjectMapper();
     mapper.setSerializationInclusion(NON_EMPTY);
     mapper.registerModule(new JodaModule());
-    return mapper;
+    return () -> mapper;
   }
 
   /**

diff --git a/nflow-engine/src/main/java/io/nflow/engine/guice/EngineModule.java b/nflow-engine/src/main/java/io/nflow/engine/guice/EngineModule.java
@@ -21,12 +21,12 @@
 import org.springframework.transaction.interceptor.TransactionInterceptor;
 import org.springframework.transaction.support.TransactionTemplate;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
 import com.google.inject.AbstractModule;
 import com.google.inject.Provides;
 import com.google.inject.Singleton;
 
 import io.nflow.engine.config.EngineConfiguration;
+import io.nflow.engine.config.EngineConfiguration.EngineObjectMapperSupplier;
 import io.nflow.engine.config.NFlow;
 import io.nflow.engine.config.db.DatabaseConfiguration;
 import io.nflow.engine.config.db.Db2DatabaseConfiguration;
@@ -95,8 +95,8 @@ public WorkflowInstanceExecutor nflowExecutor(@NFlow ThreadFactory factory, Envi
   @Provides
   @NFlow
   @Singleton
-  public ObjectMapper nflowObjectMapper() {
-    return engineConfiguration.nflowObjectMapper();
+  public EngineObjectMapperSupplier nflowObjectMapper() {
+    return () -> engineConfiguration.nflowObjectMapper().get();
   }
 
   @Provides

diff --git a/nflow-engine/src/main/java/io/nflow/engine/internal/dao/WorkflowDefinitionDao.java b/nflow-engine/src/main/java/io/nflow/engine/internal/dao/WorkflowDefinitionDao.java
@@ -20,6 +20,7 @@
 import java.util.Map;
 import java.util.Map.Entry;
 
+import io.nflow.engine.config.EngineConfiguration.EngineObjectMapperSupplier;
 import jakarta.inject.Inject;
 
 import org.slf4j.Logger;
@@ -52,11 +53,11 @@ public class WorkflowDefinitionDao {
   @Inject
   public WorkflowDefinitionDao(SQLVariants sqlVariants,
                                @NFlow NamedParameterJdbcTemplate nflowNamedParameterJdbcTemplate,
-                               @NFlow ObjectMapper nflowObjectMapper,
+                               @NFlow EngineObjectMapperSupplier nflowObjectMapper,
                                ExecutorDao executorDao) {
     this.sqlVariants = sqlVariants;
     this.namedJdbc = nflowNamedParameterJdbcTemplate;
-    this.nflowObjectMapper = nflowObjectMapper;
+    this.nflowObjectMapper = nflowObjectMapper.get();
     this.executorInfo = executorDao;
   }
 

diff --git a/nflow-engine/src/main/java/io/nflow/engine/internal/workflow/ObjectStringMapper.java b/nflow-engine/src/main/java/io/nflow/engine/internal/workflow/ObjectStringMapper.java
@@ -5,6 +5,7 @@
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Type;
 
+import io.nflow.engine.config.EngineConfiguration.EngineObjectMapperSupplier;
 import jakarta.inject.Inject;
 
 import org.springframework.stereotype.Component;
@@ -24,8 +25,8 @@ public class ObjectStringMapper {
   private final ObjectMapper mapper;
 
   @Inject
-  public ObjectStringMapper(@NFlow ObjectMapper nflowObjectMapper) {
-    this.mapper = nflowObjectMapper;
+  public ObjectStringMapper(@NFlow EngineObjectMapperSupplier nflowObjectMapper) {
+    this.mapper = nflowObjectMapper.get();
   }
 
   @SuppressWarnings("unchecked")

diff --git a/nflow-engine/src/test/java/io/nflow/engine/config/EngineConfigurationTest.java b/nflow-engine/src/test/java/io/nflow/engine/config/EngineConfigurationTest.java
@@ -70,7 +70,7 @@ public void nflowThreadFactoryInstantiated() {
 
   @Test
   public void nflowObjectMapperInstantiated() {
-    ObjectMapper mapper = configuration.nflowObjectMapper();
+    ObjectMapper mapper = configuration.nflowObjectMapper().get();
     assertThat(mapper.canSerialize(DateTime.class), is(true));
     assertThat(mapper.getSerializationConfig().getDefaultPropertyInclusion().getValueInclusion(),
         is(JsonInclude.Include.NON_EMPTY));

diff --git a/nflow-engine/src/test/java/io/nflow/engine/guice/EngineModuleTest.java b/nflow-engine/src/test/java/io/nflow/engine/guice/EngineModuleTest.java
@@ -27,6 +27,7 @@
 import com.zaxxer.hikari.HikariDataSource;
 
 import io.nflow.engine.config.EngineConfiguration;
+import io.nflow.engine.config.EngineConfiguration.EngineObjectMapperSupplier;
 import io.nflow.engine.config.NFlow;
 import io.nflow.engine.config.db.H2DatabaseConfiguration;
 import io.nflow.engine.internal.executor.WorkflowInstanceExecutor;
@@ -62,7 +63,7 @@ public void testEngineConfiguration() {
     assertThat(((CustomizableThreadFactory) factory).getThreadNamePrefix(), is("nflow-executor-"));
     assertThat(((CustomizableThreadFactory) factory).getThreadGroup().getName(), is("nflow"));
 
-    ObjectMapper mapper = injector.getInstance(Key.get(ObjectMapper.class, NFlow.class));
+    ObjectMapper mapper = injector.getInstance(Key.get(EngineObjectMapperSupplier.class, NFlow.class)).get();
     assertThat(mapper.canSerialize(DateTime.class), is(true));
     assertThat(mapper.getSerializationConfig().getDefaultPropertyInclusion().getValueInclusion(),
         is(JsonInclude.Include.NON_EMPTY));

diff --git a/nflow-engine/src/test/java/io/nflow/engine/internal/dao/DaoTestConfiguration.java b/nflow-engine/src/test/java/io/nflow/engine/internal/dao/DaoTestConfiguration.java
@@ -4,6 +4,7 @@
 
 import javax.sql.DataSource;
 
+import io.nflow.engine.config.EngineConfiguration.EngineObjectMapperSupplier;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Import;
 import org.springframework.context.annotation.PropertySource;
@@ -53,7 +54,7 @@ public WorkflowInstanceDao workflowInstanceDao(SQLVariants sqlVariants,
   @Bean
   public WorkflowDefinitionDao workflowDefinitionDao(SQLVariants sqlVariants,
                                                      @NFlow NamedParameterJdbcTemplate nflowNamedParameterJdbcTemplate,
-                                                     @NFlow ObjectMapper nflowObjectMapper,
+                                                     @NFlow EngineObjectMapperSupplier nflowObjectMapper,
                                                      ExecutorDao executorDao) {
     return new WorkflowDefinitionDao(sqlVariants,
             nflowNamedParameterJdbcTemplate,
@@ -94,11 +95,11 @@ public PlatformTransactionManager transactionManager(DataSource ds) {
 
   @Bean
   @NFlow
-  public ObjectMapper objectMapper() {
+  public EngineObjectMapperSupplier objectMapper() {
     ObjectMapper mapper = new ObjectMapper();
     mapper.setSerializationInclusion(NON_EMPTY);
     mapper.registerModule(new JodaModule());
-    return mapper;
+    return () -> mapper;
   }
 
   @Bean

diff --git a/nflow-engine/src/test/java/io/nflow/engine/internal/executor/WorkflowStateProcessorTest.java b/nflow-engine/src/test/java/io/nflow/engine/internal/executor/WorkflowStateProcessorTest.java
@@ -176,7 +176,7 @@ public class WorkflowStateProcessorTest extends BaseNflowTest {
   @Captor
   ArgumentCaptor<List<WorkflowInstance>> workflows;
 
-  ObjectStringMapper objectMapper = new ObjectStringMapper(new ObjectMapper());
+  ObjectStringMapper objectMapper = new ObjectStringMapper(ObjectMapper::new);
 
   WorkflowStateProcessor executor;
 

diff --git a/nflow-engine/src/test/java/io/nflow/engine/internal/workflow/ObjectStringMapperTest.java b/nflow-engine/src/test/java/io/nflow/engine/internal/workflow/ObjectStringMapperTest.java
@@ -20,7 +20,7 @@
 @ExtendWith(MockitoExtension.class)
 class ObjectStringMapperTest {
 
-  private final ObjectStringMapper mapper = new ObjectStringMapper(new ObjectMapper());
+  private final ObjectStringMapper mapper = new ObjectStringMapper(ObjectMapper::new);
 
   @Mock
   StateExecution execution;

diff --git a/nflow-rest-api-common/src/main/java/io/nflow/rest/config/RestConfiguration.java b/nflow-rest-api-common/src/main/java/io/nflow/rest/config/RestConfiguration.java
@@ -2,33 +2,28 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import io.nflow.engine.config.EngineConfiguration;
+import io.nflow.engine.config.EngineConfiguration.EngineObjectMapperSupplier;
 import io.nflow.engine.config.NFlow;
 import jakarta.inject.Named;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
-import org.springframework.context.annotation.Primary;
 
 import static com.fasterxml.jackson.databind.DeserializationFeature.FAIL_ON_TRAILING_TOKENS;
 import static com.fasterxml.jackson.databind.SerializationFeature.WRITE_DATES_AS_TIMESTAMPS;
 
-/**
- * This configuration configures default ObjectMapper to use. If you don't want to use it
- * you can import {@link EngineConfiguration} and define primary ObjectMapper nflowRestObjectMapper bean.
- */
 @Configuration
 @Import({ EngineConfiguration.class, NflowRestApiPropertiesConfiguration.class })
 @ComponentScan("io.nflow.rest")
 public class RestConfiguration {
 
   public static final String REST_OBJECT_MAPPER = "nflowRestObjectMapper";
 
-  @Primary
   @Bean
   @Named(REST_OBJECT_MAPPER)
-  public ObjectMapper nflowRestObjectMapper(@NFlow ObjectMapper nflowObjectMapper) {
-    ObjectMapper restObjectMapper = nflowObjectMapper.copy();
+  public ObjectMapper nflowRestObjectMapper(@NFlow EngineObjectMapperSupplier nflowObjectMapper) {
+    ObjectMapper restObjectMapper = nflowObjectMapper.get().copy();
     restObjectMapper.configure(WRITE_DATES_AS_TIMESTAMPS, false);
     restObjectMapper.enable(FAIL_ON_TRAILING_TOKENS);
     return restObjectMapper;

diff --git a/...rest-api-common/src/test/java/io/nflow/rest/v1/converter/CreateWorkflowConverterTest.java b/...rest-api-common/src/test/java/io/nflow/rest/v1/converter/CreateWorkflowConverterTest.java
@@ -27,7 +27,7 @@
 public class CreateWorkflowConverterTest {
 
   @Spy
-  private final ObjectStringMapper objectMapper = new ObjectStringMapper(new ObjectMapper());
+  private final ObjectStringMapper objectMapper = new ObjectStringMapper(ObjectMapper::new);
 
   private CreateWorkflowConverter converter;
 

diff --git a/nflow-rest-api-jax-rs/src/test/java/io/nflow/rest/v1/config/jaxrs/RestConfigurationTest.java b/nflow-rest-api-jax-rs/src/test/java/io/nflow/rest/v1/config/jaxrs/RestConfigurationTest.java
@@ -25,7 +25,7 @@ public void setup() {
 
   @Test
   public void nflowRestObjectMapperInstantiated() {
-    ObjectMapper restMapper = configuration.nflowRestObjectMapper(new ObjectMapper());
+    ObjectMapper restMapper = configuration.nflowRestObjectMapper(ObjectMapper::new);
     assertThat(restMapper.getSerializationConfig().hasSerializationFeatures(WRITE_DATES_AS_TIMESTAMPS.getMask()), is(false));
   }
 }
diff --git a/nflow-rest-api-jax-rs/src/test/java/io/nflow/rest/v1/jaxrs/WorkflowInstanceResourceTest.java b/nflow-rest-api-jax-rs/src/test/java/io/nflow/rest/v1/jaxrs/WorkflowInstanceResourceTest.java
@@ -95,7 +95,7 @@ public void setup() {
     resource = new WorkflowInstanceResource(workflowInstances, createWorkflowConverter, listWorkflowConverter,
         workflowInstanceFactory, workflowInstanceDao);
     lenient().when(workflowInstanceFactory.newWorkflowInstanceBuilder())
-        .thenReturn(new WorkflowInstance.Builder(new ObjectStringMapper(new ObjectMapper())));
+        .thenReturn(new WorkflowInstance.Builder(new ObjectStringMapper(ObjectMapper::new)));
   }
 
   @Test