feat(spring): Support automatic initialization of index templates (#991)

* feat(spring): Support automatic initialization of index templates
Ahoo-Wang · Nov 12, 2024 · ec2ac79 · ec2ac79
1 parent b16799c
commit ec2ac79
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 1 deletion.
diff --git a/wow-elasticsearch/src/main/kotlin/me/ahoo/wow/elasticsearch/IndexTemplateInitializer.kt b/wow-elasticsearch/src/main/kotlin/me/ahoo/wow/elasticsearch/IndexTemplateInitializer.kt
@@ -15,6 +15,7 @@ package me.ahoo.wow.elasticsearch
 
 import com.fasterxml.jackson.databind.JsonNode
 import com.google.common.io.Resources
+import me.ahoo.wow.messaging.dispatcher.SafeSubscriber
 import me.ahoo.wow.serialization.toJsonString
 import me.ahoo.wow.serialization.toObject
 import org.springframework.core.io.ClassPathResource
@@ -69,4 +70,11 @@ class IndexTemplateInitializer(private val elasticsearchOperations: ReactiveElas
         return elasticsearchOperations.indexOps(IndexCoordinates.of(name))
             .putIndexTemplate(putIndexTemplateRequest)
     }
+
+    fun initAll() {
+        initEventStreamTemplate().subscribe(InitSubscriber("InitEventStreamTemplate"))
+        initSnapshotTemplate().subscribe(InitSubscriber("InitEventStreamTemplate"))
+    }
+
+    class InitSubscriber(override val name: String) : SafeSubscriber<Boolean>()
 }
diff --git a/...ahoo/wow/spring/boot/starter/elasticsearch/ElasticsearchEventSourcingAutoConfiguration.kt b/...ahoo/wow/spring/boot/starter/elasticsearch/ElasticsearchEventSourcingAutoConfiguration.kt
@@ -14,6 +14,7 @@
 package me.ahoo.wow.spring.boot.starter.elasticsearch
 
 import co.elastic.clients.json.jackson.JacksonJsonpMapper
+import me.ahoo.wow.elasticsearch.IndexTemplateInitializer
 import me.ahoo.wow.elasticsearch.WowJsonpMapper
 import me.ahoo.wow.elasticsearch.eventsourcing.ElasticsearchEventStore
 import me.ahoo.wow.elasticsearch.eventsourcing.ElasticsearchSnapshotRepository
@@ -35,12 +36,13 @@ import org.springframework.boot.autoconfigure.elasticsearch.ElasticsearchRestCli
 import org.springframework.boot.context.properties.EnableConfigurationProperties
 import org.springframework.context.annotation.Bean
 import org.springframework.data.elasticsearch.client.elc.ReactiveElasticsearchClient
+import org.springframework.data.elasticsearch.core.ReactiveElasticsearchOperations
 
 @AutoConfiguration(after = [ElasticsearchRestClientAutoConfiguration::class])
 @ConditionalOnWowEnabled
 @ConditionalOnClass(ElasticsearchEventStore::class)
 @EnableConfigurationProperties(ElasticsearchProperties::class)
-class ElasticsearchEventSourcingAutoConfiguration {
+class ElasticsearchEventSourcingAutoConfiguration(private val elasticsearchProperties: ElasticsearchProperties) {
 
     @Bean
     fun jacksonJsonpMapper(): JacksonJsonpMapper {
@@ -59,6 +61,20 @@ class ElasticsearchEventSourcingAutoConfiguration {
         return ElasticsearchEventStore(elasticsearchClient)
     }
 
+    @Bean
+    @ConditionalOnProperty(
+        EventStoreProperties.STORAGE,
+        matchIfMissing = true,
+        havingValue = StorageType.ELASTICSEARCH_NAME,
+    )
+    fun indexTemplateInitializer(elasticsearchOperations: ReactiveElasticsearchOperations): IndexTemplateInitializer {
+        val initializer = IndexTemplateInitializer(elasticsearchOperations)
+        if (elasticsearchProperties.autoInitTemplate) {
+            initializer.initAll()
+        }
+        return initializer
+    }
+
     @Bean
     @ConditionalOnProperty(
         EventStoreProperties.STORAGE,

diff --git a/.../wow/spring/boot/starter/elasticsearch/ElasticsearchEventSourcingAutoConfigurationTest.kt b/.../wow/spring/boot/starter/elasticsearch/ElasticsearchEventSourcingAutoConfigurationTest.kt
@@ -14,6 +14,9 @@
 package me.ahoo.wow.spring.boot.starter.elasticsearch
 
 import co.elastic.clients.json.jackson.JacksonJsonpMapper
+import io.mockk.every
+import io.mockk.mockk
+import me.ahoo.wow.elasticsearch.IndexTemplateInitializer
 import me.ahoo.wow.elasticsearch.eventsourcing.ElasticsearchEventStore
 import me.ahoo.wow.elasticsearch.eventsourcing.ElasticsearchSnapshotRepository
 import me.ahoo.wow.elasticsearch.query.event.ElasticsearchEventStreamQueryServiceFactory
@@ -28,19 +31,31 @@ import org.mockito.Mockito.mock
 import org.springframework.boot.test.context.assertj.AssertableApplicationContext
 import org.springframework.boot.test.context.runner.ApplicationContextRunner
 import org.springframework.data.elasticsearch.client.elc.ReactiveElasticsearchClient
+import org.springframework.data.elasticsearch.core.ReactiveElasticsearchOperations
+import org.springframework.data.elasticsearch.core.ReactiveIndexOperations
+import org.springframework.data.elasticsearch.core.mapping.IndexCoordinates
+import reactor.kotlin.core.publisher.toMono
 
 internal class ElasticsearchEventSourcingAutoConfigurationTest {
     private val contextRunner = ApplicationContextRunner()
 
     @Test
     fun contextLoads() {
+        val elasticsearchTemplate = mockk<ReactiveElasticsearchOperations> {
+            every { indexOps(any<IndexCoordinates>()) } returns mockk<ReactiveIndexOperations> {
+                every { putIndexTemplate(any()) } returns true.toMono()
+            }
+        }
         contextRunner
             .enableWow()
             .withPropertyValues("${SnapshotProperties.STORAGE}=${StorageType.ELASTICSEARCH_NAME}")
             .withPropertyValues("${EventStoreProperties.STORAGE}=${StorageType.ELASTICSEARCH_NAME}")
             .withBean(ReactiveElasticsearchClient::class.java, {
                 mock(ReactiveElasticsearchClient::class.java)
             })
+            .withBean(ReactiveElasticsearchOperations::class.java, {
+                elasticsearchTemplate
+            })
             .withUserConfiguration(
                 ElasticsearchEventSourcingAutoConfiguration::class.java,
             )
@@ -49,6 +64,7 @@ internal class ElasticsearchEventSourcingAutoConfigurationTest {
                     .hasSingleBean(JacksonJsonpMapper::class.java)
                     .hasSingleBean(ElasticsearchEventStore::class.java)
                     .hasSingleBean(ElasticsearchEventStreamQueryServiceFactory::class.java)
+                    .hasSingleBean(IndexTemplateInitializer::class.java)
                     .hasSingleBean(ElasticsearchSnapshotRepository::class.java)
                     .hasSingleBean(ElasticsearchSnapshotQueryServiceFactory::class.java)
             }