Skip to content

Detect postgres timeout exceptions. #385

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

Open
Amarrd wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Detect postgres timeout exceptions. #385

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
16 changes: 15 additions & 1 deletion morf-core/src/main/java/org/alfasoftware/morf/jdbc/DatabaseExceptionHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

package org.alfasoftware.morf.jdbc;

import java.sql.SQLException;
import java.sql.SQLTimeoutException;

import org.apache.commons.lang3.exception.ExceptionUtils;
Expand All @@ -37,10 +38,15 @@ public class DatabaseExceptionHelper {
*/
static final String MYSQL_TIMEOUT_EXCEPTION_NAME = "MySQLTimeoutException";

/**
* The SQLState code used by postgres when a query has been cancelled. This code has some ambiguity, as queries can
* be cancelled due to a timeout, or a user request, but it's the best indication we have.
*/
private static final String POSTGRES_QUERY_CANCELLED_SQL_STATE = "57014";

/**
* <p>Checks if the throwable was caused by timeout exception.</p>
* <b>This method has been tested for Oracle and MySQL only and might not work
* <b>This method has been tested for Oracle, MySQL & Postgres only and might not work
* for other DB engines.</b>
*
* @param throwable to check
Expand All @@ -59,6 +65,14 @@ public boolean isCausedByTimeoutException(Throwable throwable) {
if (MYSQL_TIMEOUT_EXCEPTION_NAME.equals(causeThrowable.getClass().getSimpleName())) {
return true;
}
// Postgres doesn't have a distinct timeout exception class. Instead it throws
// a plain PSQLException with a particular SQLState that needs to be checked
if (causeThrowable instanceof SQLException) {
String sqlState = ((SQLException) causeThrowable).getSQLState();
if (POSTGRES_QUERY_CANCELLED_SQL_STATE.equals(sqlState)) {
return true;
}
}
}
return false;
}
Expand Down
27 changes: 24 additions & 3 deletions morf-core/src/test/java/org/alfasoftware/morf/jdbc/TestDatabaseExceptionHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

package org.alfasoftware.morf.jdbc;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.*;

import java.sql.SQLException;
import java.sql.SQLTimeoutException;
Expand All @@ -40,7 +40,7 @@ public class TestDatabaseExceptionHelper {
@Test
public void testIsCausedByTimeoutForSQLTimeoutException() {
// when then
assertEquals(true, databaseExceptionHelper.isCausedByTimeoutException(new ExtendsSQLTimeoutException()));
assertTrue(databaseExceptionHelper.isCausedByTimeoutException(new ExtendsSQLTimeoutException()));
}


Expand All @@ -51,9 +51,30 @@ public void testIsCausedByTimeoutForSQLTimeoutException() {
@Test
public void testIsCausedByTimeoutForMySQLTimeoutException() {
// when then
assertEquals(true, databaseExceptionHelper.isCausedByTimeoutException(new MySQLTimeoutException()));
assertTrue(databaseExceptionHelper.isCausedByTimeoutException(new MySQLTimeoutException()));
}


/**
* Test if detection works for postgres SQLState based exceptions
*/
@Test
public void testIsCausedByTimeoutForPostgresTimeoutException() {
// when then
assertTrue(databaseExceptionHelper.isCausedByTimeoutException(new SQLException("Timeout", "57014")));
}


/**
* Test if detection works for postgres SQLState based exceptions
*/
@Test
public void testIsNotCausedByTimeout() {
// when then
assertFalse(databaseExceptionHelper.isCausedByTimeoutException(new SQLException("Some other error", "0")));
}


/**
* Test only generic exception which extends {@link SQLTimeoutException}
*
Expand Down