Skip to content

Improve JDBC Chat Memory #2662

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Improve JDBC Chat Memory #2662

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions ...ingframework/ai/model/chat/memory/jdbc/autoconfigure/JdbcChatMemoryAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,25 @@
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration;
import org.springframework.boot.autoconfigure.sql.init.OnDatabaseInitializationCondition;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.jdbc.init.DataSourceScriptDatabaseInitializer;
import org.springframework.boot.sql.init.dependency.DatabaseInitializationDependencyConfigurer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Import;
import org.springframework.jdbc.core.JdbcTemplate;

/**
* @author Jonathan Leijendekker
* @author Eddú Meléndez
* @since 1.0.0
*/
@AutoConfiguration(after = JdbcTemplateAutoConfiguration.class)
@ConditionalOnClass({ JdbcChatMemory.class, DataSource.class, JdbcTemplate.class })
@EnableConfigurationProperties(JdbcChatMemoryProperties.class)
@Import(DatabaseInitializationDependencyConfigurer.class)
public class JdbcChatMemoryAutoConfiguration {

private static final Logger logger = LoggerFactory.getLogger(JdbcChatMemoryAutoConfiguration.class);
Expand All @@ -54,12 +59,20 @@ public JdbcChatMemory chatMemory(JdbcTemplate jdbcTemplate) {

@Bean
@ConditionalOnMissingBean
@ConditionalOnProperty(value = "spring.ai.chat.memory.jdbc.initialize-schema", havingValue = "true",
matchIfMissing = true)
public DataSourceScriptDatabaseInitializer jdbcChatMemoryScriptDatabaseInitializer(DataSource dataSource) {
@Conditional(OnJdbcChatMemoryDatasourceInitializationCondition.class)
public DataSourceScriptDatabaseInitializer jdbcChatMemoryScriptDatabaseInitializer(DataSource dataSource,
JdbcChatMemoryProperties properties) {
logger.debug("Initializing JdbcChatMemory schema");

return new JdbcChatMemoryDataSourceScriptDatabaseInitializer(dataSource);
return new JdbcChatMemoryDataSourceScriptDatabaseInitializer(dataSource, properties);
}

static class OnJdbcChatMemoryDatasourceInitializationCondition extends OnDatabaseInitializationCondition {

OnJdbcChatMemoryDatasourceInitializationCondition() {
super("Jdbc Chat Memory", "spring.ai.chat.memory.jdbc.initialize-schema");
}

}

}
10 changes: 5 additions & 5 deletions ...del/chat/memory/jdbc/autoconfigure/JdbcChatMemoryDataSourceScriptDatabaseInitializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@

import org.springframework.boot.jdbc.init.DataSourceScriptDatabaseInitializer;
import org.springframework.boot.jdbc.init.PlatformPlaceholderDatabaseDriverResolver;
import org.springframework.boot.sql.init.DatabaseInitializationMode;
import org.springframework.boot.sql.init.DatabaseInitializationSettings;

class JdbcChatMemoryDataSourceScriptDatabaseInitializer extends DataSourceScriptDatabaseInitializer {

private static final String SCHEMA_LOCATION = "classpath:org/springframework/ai/chat/memory/jdbc/schema-@@platform@@.sql";

public JdbcChatMemoryDataSourceScriptDatabaseInitializer(DataSource dataSource) {
super(dataSource, getSettings(dataSource));
public JdbcChatMemoryDataSourceScriptDatabaseInitializer(DataSource dataSource,
JdbcChatMemoryProperties properties) {
super(dataSource, getSettings(dataSource, properties));
}

static DatabaseInitializationSettings getSettings(DataSource dataSource) {
static DatabaseInitializationSettings getSettings(DataSource dataSource, JdbcChatMemoryProperties properties) {
var settings = new DatabaseInitializationSettings();
settings.setSchemaLocations(resolveSchemaLocations(dataSource));
settings.setMode(DatabaseInitializationMode.ALWAYS);
settings.setMode(properties.getInitializeSchema());
settings.setContinueOnError(true);

return settings;
Expand Down
11 changes: 8 additions & 3 deletions ...org/springframework/ai/model/chat/memory/jdbc/autoconfigure/JdbcChatMemoryProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,28 @@
package org.springframework.ai.model.chat.memory.jdbc.autoconfigure;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.sql.init.DatabaseInitializationMode;

/**
* @author Jonathan Leijendekker
* @author Eddú Meléndez
* @since 1.0.0
*/
@ConfigurationProperties(JdbcChatMemoryProperties.CONFIG_PREFIX)
public class JdbcChatMemoryProperties {

public static final String CONFIG_PREFIX = "spring.ai.chat.memory.jdbc";

private boolean initializeSchema = true;
/**
* Database schema initialization mode.
*/
private DatabaseInitializationMode initializeSchema = DatabaseInitializationMode.EMBEDDED;

public boolean isInitializeSchema() {
public DatabaseInitializationMode getInitializeSchema() {
return this.initializeSchema;
}

public void setInitializeSchema(boolean initializeSchema) {
public void setInitializeSchema(DatabaseInitializationMode initializeSchema) {
this.initializeSchema = initializeSchema;
}

Expand Down
7 changes: 4 additions & 3 deletions ...gframework/ai/model/chat/memory/jdbc/autoconfigure/JdbcChatMemoryAutoConfigurationIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@

/**
* @author Jonathan Leijendekker
* @author Eddú Meléndez
*/
@Testcontainers
class JdbcChatMemoryAutoConfigurationIT {
Expand All @@ -60,21 +61,21 @@ class JdbcChatMemoryAutoConfigurationIT {

@Test
void jdbcChatMemoryScriptDatabaseInitializer_shouldBeLoaded() {
this.contextRunner.withPropertyValues("spring.ai.chat.memory.jdbc.initialize-schema=true").run(context -> {
this.contextRunner.withPropertyValues("spring.ai.chat.memory.jdbc.initialize-schema=always").run(context -> {
assertThat(context.containsBean("jdbcChatMemoryScriptDatabaseInitializer")).isTrue();
});
}

@Test
void jdbcChatMemoryScriptDatabaseInitializer_shouldNotBeLoaded() {
this.contextRunner.withPropertyValues("spring.ai.chat.memory.jdbc.initialize-schema=false").run(context -> {
this.contextRunner.withPropertyValues("spring.ai.chat.memory.jdbc.initialize-schema=never").run(context -> {
assertThat(context.containsBean("jdbcChatMemoryScriptDatabaseInitializer")).isFalse();
});
}

@Test
void addGetAndClear_shouldAllExecute() {
this.contextRunner.withPropertyValues("spring.ai.chat.memory.jdbc.initialize-schema=true").run(context -> {
this.contextRunner.withPropertyValues("spring.ai.chat.memory.jdbc.initialize-schema=always").run(context -> {
var chatMemory = context.getBean(JdbcChatMemory.class);
var conversationId = UUID.randomUUID().toString();
var userMessage = new UserMessage("Message from the user");
Expand Down
4 changes: 3 additions & 1 deletion ...hat/memory/jdbc/autoconfigure/JdbcChatMemoryDataSourceScriptDatabaseInitializerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

/**
* @author Jonathan Leijendekker
* @author Eddú Meléndez
*/
@Testcontainers
class JdbcChatMemoryDataSourceScriptDatabaseInitializerTests {
Expand All @@ -41,7 +42,8 @@ class JdbcChatMemoryDataSourceScriptDatabaseInitializerTests {
void getSettings_shouldHaveSchemaLocations() {
this.contextRunner.run(context -> {
var dataSource = context.getBean(DataSource.class);
var settings = JdbcChatMemoryDataSourceScriptDatabaseInitializer.getSettings(dataSource);
var properties = context.getBean(JdbcChatMemoryProperties.class);
var settings = JdbcChatMemoryDataSourceScriptDatabaseInitializer.getSettings(dataSource, properties);

assertThat(settings.getSchemaLocations())
.containsOnly("classpath:org/springframework/ai/chat/memory/jdbc/schema-postgresql.sql");
Expand Down
43 changes: 0 additions & 43 deletions ...pringframework/ai/model/chat/memory/jdbc/autoconfigure/JdbcChatMemoryPropertiesTests.java
View file
Open in desktop

This file was deleted.

3 changes: 1 addition & 2 deletions ...hat-memory-jdbc/src/main/java/org/springframework/ai/chat/memory/jdbc/JdbcChatMemory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@
*/
public class JdbcChatMemory implements ChatMemory {

private static final String QUERY_ADD = """
INSERT INTO ai_chat_memory (conversation_id, content, type) VALUES (?, ?, ?)""";
private static final String QUERY_ADD = "INSERT INTO ai_chat_memory (conversation_id, content, type) VALUES (?, ?, ?)";

private static final String QUERY_GET = """
SELECT content, type FROM ai_chat_memory WHERE conversation_id = ? ORDER BY "timestamp" DESC LIMIT ?""";
Expand Down
7 changes: 1 addition & 6 deletions ...t-memory-jdbc/src/test/java/org/springframework/ai/chat/memory/jdbc/JdbcChatMemoryIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@

import javax.sql.DataSource;

import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;
Expand All @@ -47,6 +46,7 @@

/**
* @author Jonathan Leijendekker
* @author Eddú Meléndez
*/
@Testcontainers
class JdbcChatMemoryIT {
Expand All @@ -67,11 +67,6 @@ class JdbcChatMemoryIT {
String.format("app.datasource.username=%s", postgresContainer.getUsername()),
String.format("app.datasource.password=%s", postgresContainer.getPassword()));

@BeforeAll
static void beforeAll() {

}

@Test
void correctChatMemoryInstance() {
this.contextRunner.run(context -> {
Expand Down