Skip to content
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

Jump to bottom

Reinitialize SQLErrorCodeSQLExceptionTranslator when initial JDBC connection retrieval failed #23676

Closed
wants to merge 1 commit into from
Closed

Reinitialize SQLErrorCodeSQLExceptionTranslator when initial JDBC connection retrieval failed #23676

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions ...bc/src/main/java/org/springframework/jdbc/support/SQLErrorCodeSQLExceptionTranslator.java
View file
Open in desktop
Expand Up @@ -78,6 +78,10 @@ public class SQLErrorCodeSQLExceptionTranslator extends AbstractFallbackSQLExcep
@Nullable
private SQLErrorCodes sqlErrorCodes;

/** Reference to the dataSource if SQLErrorCodeSQLExceptionTranslator is initialized via new SQLErrorCodeSQLExceptionTranslator(DataSource dataSource).**/
@Nullable
private DataSource dataSource;


/**
* Constructor for use as a JavaBean.
Expand All @@ -97,6 +101,7 @@ public SQLErrorCodeSQLExceptionTranslator() {
*/
public SQLErrorCodeSQLExceptionTranslator(DataSource dataSource) {
this();
this.dataSource = dataSource;
setDataSource(dataSource);
}

Expand Down Expand Up @@ -186,6 +191,10 @@ protected DataAccessException doTranslate(String task, @Nullable String sql, SQL
return dae;
}

if(this.sqlErrorCodes == null && this.dataSource != null) {
this.sqlErrorCodes = SQLErrorCodesFactory.getInstance().getErrorCodes(this.dataSource);
}

// Next, try the custom SQLException translator, if available.
if (this.sqlErrorCodes != null) {
SQLExceptionTranslator customTranslator = this.sqlErrorCodes.getCustomSqlExceptionTranslator();
Expand Down
6 changes: 6 additions & 0 deletions spring-jdbc/src/main/java/org/springframework/jdbc/support/SQLErrorCodesFactory.java
View file
Open in desktop
Expand Up @@ -29,6 +29,7 @@
import org.springframework.beans.factory.xml.XmlBeanDefinitionReader;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.jdbc.CannotGetJdbcConnectionException;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.ConcurrentReferenceHashMap;
Expand Down Expand Up @@ -219,6 +220,11 @@ public SQLErrorCodes getErrorCodes(DataSource dataSource) {
}
catch (MetaDataAccessException ex) {
logger.warn("Error while extracting database name - falling back to empty error codes", ex);
//returning null error codes will make sure that next time error codes are looked up,
//Spring will try to load the error code again
if(ex.getCause() != null && ex.getCause() instanceof CannotGetJdbcConnectionException) {
return null;
}
}
// Fallback is to return an empty SQLErrorCodes instance.
return new SQLErrorCodes();
Expand Down
49 changes: 49 additions & 0 deletions ...c/test/java/org/springframework/jdbc/support/SQLErrorCodeSQLExceptionTranslatorTests.java
View file
Open in desktop
Expand Up @@ -17,9 +17,13 @@
package org.springframework.jdbc.support;

import java.sql.BatchUpdateException;
import java.sql.Connection;
import java.sql.DataTruncation;
import java.sql.DatabaseMetaData;
import java.sql.SQLException;

import javax.sql.DataSource;

import org.junit.jupiter.api.Test;

import org.springframework.dao.CannotAcquireLockException;
Expand All @@ -30,11 +34,15 @@
import org.springframework.dao.DeadlockLoserDataAccessException;
import org.springframework.dao.DuplicateKeyException;
import org.springframework.jdbc.BadSqlGrammarException;
import org.springframework.jdbc.CannotGetJdbcConnectionException;
import org.springframework.jdbc.InvalidResultSetAccessException;
import org.springframework.lang.Nullable;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
import static org.mockito.BDDMockito.mock;
import static org.mockito.BDDMockito.when;


/**
* @author Rod Johnson
Expand Down Expand Up @@ -176,4 +184,45 @@ public void customExceptionTranslation() {
customTranslation.setExceptionClass(String.class));
}

@Test
public void testDataSourceMethodTranslation() throws SQLException {
DataSource ds = mock(DataSource.class);
Connection conn = mock(Connection.class);
DatabaseMetaData metaData = mock(DatabaseMetaData.class);
when(ds.getConnection()).thenReturn(conn);
when(conn.getMetaData()).thenReturn(metaData);
when(metaData.getDatabaseProductName()).thenReturn("H2");
SQLErrorCodeSQLExceptionTranslator translator = new SQLErrorCodeSQLExceptionTranslator(ds);
SQLErrorCodes codes = translator.getSqlErrorCodes();
assertThat(codes).isNotNull();
}

@Test
public void testDataSourceMethodTranslationConnectionFailureRetried() throws SQLException {
DataSource ds = mock(DataSource.class);
Connection conn = mock(Connection.class);
DatabaseMetaData metaData = mock(DatabaseMetaData.class);
when(ds.getConnection()).thenThrow(CannotGetJdbcConnectionException.class).thenReturn(conn);
when(conn.getMetaData()).thenReturn(metaData);
when(metaData.getDatabaseProductName()).thenReturn("H2");
SQLErrorCodeSQLExceptionTranslator translator = new SQLErrorCodeSQLExceptionTranslator(ds);
DataAccessException ex = translator.translate("task", "SQL", new SQLException("reason1", "01504", 23001));
assertThat(ex).isInstanceOf(DuplicateKeyException.class);
}

@Test
public void testDataSourceMethodTranslationConnectionFailureRetriedAndFallback() throws SQLException {
DataSource ds = mock(DataSource.class);
Connection conn = mock(Connection.class);
DatabaseMetaData metaData = mock(DatabaseMetaData.class);
when(ds.getConnection()).thenThrow(CannotGetJdbcConnectionException.class).thenThrow(CannotGetJdbcConnectionException.class).thenReturn(conn);
when(conn.getMetaData()).thenReturn(metaData);
when(metaData.getDatabaseProductName()).thenReturn("H2");
SQLErrorCodeSQLExceptionTranslator translator = new SQLErrorCodeSQLExceptionTranslator(ds);
DataAccessException ex = translator.translate("task", "SQL", new SQLException("reason1", "01504", 23001));
assertThat(ex).isNotInstanceOf(DuplicateKeyException.class);
ex = translator.translate("task", "SQL", new SQLException("reason1", "01504", 23001));
assertThat(ex).isInstanceOf(DuplicateKeyException.class);
}

}
16 changes: 15 additions & 1 deletion spring-jdbc/src/test/java/org/springframework/jdbc/support/SQLErrorCodesFactoryTests.java
View file
Open in desktop
Expand Up @@ -27,6 +27,7 @@

import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.jdbc.CannotGetJdbcConnectionException;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.BDDMockito.given;
Expand Down Expand Up @@ -245,15 +246,28 @@ public void testDataSourceWithNullMetadata() throws Exception {

@Test
public void testGetFromDataSourceWithSQLException() throws Exception {
Connection connection = mock(Connection.class);
SQLException expectedSQLException = new SQLException();

DataSource dataSource = mock(DataSource.class);
given(dataSource.getConnection()).willThrow(expectedSQLException);
given(dataSource.getConnection()).willReturn(connection);
given(connection.getMetaData()).willThrow(expectedSQLException);

SQLErrorCodes sec = SQLErrorCodesFactory.getInstance().getErrorCodes(dataSource);
assertIsEmpty(sec);
}

@Test
public void testGetFromDataSourceWithCannotGetJdbcConnectionException() throws Exception {
CannotGetJdbcConnectionException expectedException = new CannotGetJdbcConnectionException("Could not get jdbc connection", mock(SQLException.class));

DataSource dataSource = mock(DataSource.class);
given(dataSource.getConnection()).willThrow(expectedException);

SQLErrorCodes sec = SQLErrorCodesFactory.getInstance().getErrorCodes(dataSource);
assertThat(sec).isNull();
}

private void assertIsEmpty(SQLErrorCodes sec) {
// Codes should be empty
assertThat(sec.getBadSqlGrammarCodes().length).isEqualTo(0);
Expand Down