PLUGIN-1823: Retrying all SQLTransientExceptions #597

sgarg-CS · 2025-05-16T11:36:26Z

Add Failsafe Retry poilcy to all the places in the database-plugins where SQLTransientException could be thrown.

Added three new properties (hidden from UI)

Initial Retry Duration (Default: 5sec)
Max Retry Duration (Default: 80 sec)
Max Retry Count (Default: 5)

google-cla · 2025-05-16T11:36:31Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

itsankit-google

Overall, this looks everything is getting wrapped within Failsafe where we might end up with having nested level retries, we need to ensure we add retries only where we are actually interacting with JDBC client and not top level functions.

For example adding retries to DriverManager.getConnection(connectionString, connectionProperties) makes sense because you are actually interacting with the source db but adding retries to whole loadSchema(Connection connection, String query) do not makes sense we need to be careful while adding such retries.

database-commons/src/main/java/io/cdap/plugin/db/action/DBRun.java

database-commons/src/main/java/io/cdap/plugin/db/source/AbstractDBSource.java

itsankit-google · 2025-05-30T05:31:01Z

Please note E2E should not be modified and not fail with these changes. Otherwise, we have done something wrong which does not give expected failure messages.

database-commons/src/main/java/io/cdap/plugin/db/sink/AbstractDBSink.java

database-commons/src/main/java/io/cdap/plugin/db/source/AbstractDBSource.java

itsankit-google

I can see some level of duplication in both AbstractDBSource & AbstractDBSink, can we please move it to the common AbstractDBUtil class?

database-commons/src/main/java/io/cdap/plugin/db/ConnectionConfig.java

cloudsql-mysql-plugin/src/test/java/io/cdap/plugin/cloudsql/mysql/CloudSQLMySQLSinkTest.java

database-commons/src/main/java/io/cdap/plugin/db/connector/AbstractDBSpecificConnector.java

itsankit-google

public final class RetryUtils {

  public static Connection createConnectionWithRetry(RetryPolicy<?> retryPolicy, String connectionString,
                                                     Properties connectionProperties, String externalDocumentationLink) throws Exception {
    try {
      return Failsafe.with(retryPolicy).get(() ->
        DriverManager.getConnection(connectionString, connectionProperties)
      );
    } catch (Exception e) {
      throw unwrapFailsafeException(e, externalDocumentationLink);
    }
  }

  public static Statement createStatementWithRetry(RetryPolicy<?> retryPolicy,
                                                   Connection connection, String externalDocumentationLink) throws Exception {
    try {
      return Failsafe.with(retryPolicy).get(connection::createStatement);
    } catch (Exception e) {
      throw unwrapFailsafeException(e, externalDocumentationLink);
    }
  }

  public static PreparedStatement prepareStatementWithRetry(RetryPolicy<?> retryPolicy,
                                                            Connection connection,
                                                            String sqlQuery, String externalDocumentationLink) throws Exception {
    try {
      return Failsafe.with(retryPolicy).get(() ->
        connection.prepareStatement(sqlQuery)
      );
    } catch (Exception e) {
      throw unwrapFailsafeException(e, externalDocumentationLink);
    }
  }

 public static ResultSet executeWithRetry(RetryPolicy<?> retryPolicy,
                                                            Connection connection,
                                                            String sqlQuery, String externalDocumentationLink) throws Exception {
        try {
            return Failsafe.with(retryPolicy).get(() -> connection.createStatement().executeQuery(sqlQuery));
        } catch (Exception e) {
            throw unwrapFailsafeException(e, externalDocumentationLink);
        }
    }

 private static Exception unwrapFailsafeException(Exception e) {
    if (e instanceof FailsafeException && e.getCause() instanceof Exception) {
        if (e instanceOf SQLException) {
           return programFailureException(e, externalDocumentationLink);
        } else {
          return (Exception) e.getCause();
       }
    }
    return e;
  }
  
private static ProgramFailureException programFailureException(SQLException e, String externalDocumentationLink) {
    // wrap exception to ensure SQLException-child instances not exposed to contexts without jdbc
    // driver in classpath
    String errorMessage =
      String.format("SQL Exception occurred: [Message='%s', SQLState='%s', ErrorCode='%s'].",
        e.getMessage(), e.getSQLState(), e.getErrorCode());
    String errorMessageWithDetails = String.format("Error occurred while trying to" +
      " get schema from database." + "Error message: '%s'. Error code: '%s'. SQLState: '%s'", e.getMessage(),
        e.getErrorCode(), e.getSQLState());
 
    if (!Strings.isNullOrEmpty(externalDocumentationLink)) {
      if (!errorMessage.endsWith(".")) {
        errorMessage = errorMessage + ".";
      }
      errorMessage = String.format("%s For more details, see %s", errorMessage, externalDocumentationLink);
    }
    return ErrorUtils.getProgramFailureException(new ErrorCategory(ErrorCategory.ErrorCategoryEnum.PLUGIN),
      errorMessage, errorMessageWithDetails, ErrorType.USER, false, ErrorCodeType.SQLSTATE, e.getSQLState(),
        externalDocumentationLink, e);
  }
}

You can create a RetryUtils like above which accepts connection params.

database-commons/src/main/java/io/cdap/plugin/db/source/AbstractDBSource.java

Move retry logic into a separate class: RetryUtils and add exception handling

sgarg-CS · 2025-06-03T14:04:42Z

Overall, this looks everything is getting wrapped within Failsafe where we might end up with having nested level retries, we need to ensure we add retries only where we are actually interacting with JDBC client and not top level functions.

For example adding retries to DriverManager.getConnection(connectionString, connectionProperties) makes sense because you are actually interacting with the source db but adding retries to whole loadSchema(Connection connection, String query) do not makes sense we need to be careful while adding such retries.

Refactored the code to add the retry logic only for the methods interacting with the JDBC client.

database-commons/src/main/java/io/cdap/plugin/util/RetryUtils.java

database-commons/src/main/java/io/cdap/plugin/db/source/AbstractDBSource.java

database-commons/src/main/java/io/cdap/plugin/util/RetryUtils.java

database-commons/src/main/java/io/cdap/plugin/db/sink/AbstractDBSink.java

database-commons/src/main/java/io/cdap/plugin/db/source/AbstractDBSource.java

itsankit-google

How does it affect the UI if validateSchema fails for DB sinks? Can we test before/after the change?

Moved all the retry constants to RetryUtils class, Added the methods to determine error type and error category methods from Error code and SQL State

sgarg-CS · 2025-06-05T07:23:50Z

How does it affect the UI if validateSchema fails for DB sinks? Can we test before/after the change?

Yes. Will check and update the behaviour here.

I've reverted the changes done to handle SQLException thrown by validateSchema() method call from AbstractDBSink.configurePipeline class. Still, I see a change in the error message on the UI. This is probably due to catching SQLException and then wrapping it to throw ProgramFailureException. While this wrapping was done for inferSchema() but not for validateSchema() in AbstractSink class earlier.

Test Scenario: Validate the schema in PostgreSQL Sink Plugin, if connection is not active. (Postgres DB is down)

[BEFORE CHANGES]

Error message on the UI:
Exception while trying to validate schema of database table '"users2"' for connection 'jdbc:postgresql://localhost:5433/postgres' with Connection to localhost:5433 refused. Check that the hostname and port are correct and that the postmaster is accepting TCP/IP connections.

[AFTER CHANGES]

Error message on the UI:
Error encountered while configuring the stage: 'Error occurred while trying to get schema from database. Error message: 'Connection to localhost:5433 refused. Check that the hostname and port are correct and that the postmaster is accepting TCP/IP connections.'. Error code: '0'. SQLState: '08001''

Is the new error message acceptable or should we revert the changes done to throw ProgramFailureException for validateSchema() method?

itsankit-google · 2025-06-05T13:07:05Z

How does it affect the UI if validateSchema fails for DB sinks? Can we test before/after the change?

Yes. Will check and update the behaviour here.

I've reverted the changes done to handle SQLException thrown by validateSchema() method call from AbstractDBSink.configurePipeline class. Still, I see a change in the error message on the UI. This is probably due to catching SQLException and then wrapping it to throw ProgramFailureException. While this wrapping was done for inferSchema() but not for validateSchema() in AbstractSink class earlier.

Test Scenario: Validate the schema in PostgreSQL Sink Plugin, if connection is not active. (Postgres DB is down)

[BEFORE CHANGES]

Error message on the UI: Exception while trying to validate schema of database table '"users2"' for connection 'jdbc:postgresql://localhost:5433/postgres' with Connection to localhost:5433 refused. Check that the hostname and port are correct and that the postmaster is accepting TCP/IP connections.

[AFTER CHANGES]

Error message on the UI: Error encountered while configuring the stage: 'Error occurred while trying to get schema from database. Error message: 'Connection to localhost:5433 refused. Check that the hostname and port are correct and that the postmaster is accepting TCP/IP connections.'. Error code: '0'. SQLState: '08001''

Is the new error message acceptable or should we revert the changes done to throw ProgramFailureException for validateSchema() method?

LGTM

database-commons/src/main/java/io/cdap/plugin/util/RetryUtils.java

database-commons/src/main/java/io/cdap/plugin/db/action/AbstractDBArgumentSetter.java

database-commons/src/main/java/io/cdap/plugin/util/RetryUtils.java

itsankit-google · 2025-06-24T09:16:45Z

oracle-plugin/src/e2e-test/resources/errorMessage.properties

@@ -12,7 +12,7 @@ errorMessageInvalidImportQuery=Import Query select must contain the string '$CON
  \ to 1. Include '$CONDITIONS' in the Import Query
 errorMessageBlankUsername=Username is required when password is given.
 errorMessageInvalidTableName=Error encountered while configuring the stage: 'Error occurred while trying to get schema from database.Error message: 'IO Error: Unknown host specified '. Error code: '17002'. SQLState: '08006''
-errorMessageInvalidSinkDatabase=Error encountered while configuring the stage: 'Error occurred while trying to get schema from database.Error message: 'IO Error: Unknown host specified '. Error code: '17002'. SQLState: '08006''
+errorMessageInvalidSinkDatabase=Error encountered while configuring the stage: 'Error occurred while trying to get schema from database.


This is not correct, why are we making the error message generic, it should cover the exact error message like before.

itsankit-google · 2025-06-24T09:17:20Z

cloudsql-mysql-plugin/src/e2e-test/resources/errorMessage.properties

@@ -1,4 +1,4 @@
-errorMessageInvalidSourceDatabase=Error occurred while trying to get schema from database.Error message: 'Access denied for user '
+errorMessageInvalidSourceDatabase=Error occurred while trying to get schema from database.


similar comment here, it applies for all the error messages in the PR where we are reducing the exact messages and making it generic

if the error messages are not coming like before, there is something wrong with the changes and we should fix there.

database-commons/src/main/java/io/cdap/plugin/db/source/AbstractDBSource.java

database-commons/src/main/java/io/cdap/plugin/db/sink/AbstractDBSink.java

…rn types for overridden methods to base class

itsankit-google · 2025-06-26T08:36:46Z

database-commons/src/main/java/io/cdap/plugin/db/source/AbstractDBSource.java

  protected String getExternalDocumentationLink() {
-    return null;
+    return "https://en.wikipedia.org/wiki/SQLSTATE";


is this method still needed? can we remove it?

Not needed now. Removed. 7c8815d

itsankit-google · 2025-06-26T08:40:40Z

database-commons/src/main/java/io/cdap/plugin/db/action/AbstractDBArgumentSetter.java

+  protected String getExternalDocumentationLink() {
+    return "https://en.wikipedia.org/wiki/SQLSTATE";
+  }


is this method still needed?

No, not needed now. Removed it. 7c8815d

…t longer used now.

itsankit-google · 2025-06-26T11:25:10Z

database-commons/src/main/java/io/cdap/plugin/db/source/AbstractDBSource.java

@@ -87,13 +86,17 @@ public abstract class AbstractDBSource<T extends PluginConfig & DatabaseSourceCo
                                                                Pattern.CASE_INSENSITIVE);
  private static final Pattern WHERE_CONDITIONS = Pattern.compile("\\s+where \\$conditions",
                                                                  Pattern.CASE_INSENSITIVE);
+  private final RetryPolicy<?> retryPolicy;



please remove empty line

Removed 0b57ce6

itsankit-google · 2025-06-26T11:25:49Z

database-commons/src/main/java/io/cdap/plugin/db/RetryExceptions.java

+import java.sql.SQLTransientException;
+import java.util.HashSet;
+import java.util.Set;
+


please remove empty line

Removed 0b57ce6

psainics force-pushed the patch/plugin-1823 branch from 7fcb0a0 to 9da75b8 Compare May 19, 2025 09:01

psainics added the build label May 19, 2025

itsmekumari mentioned this pull request May 22, 2025

error message changes #598

Merged

PLUGIN-1823: Retrying all SQLTransientExceptions

ac813f0

sgarg-CS force-pushed the patch/plugin-1823 branch from 9da75b8 to ac813f0 Compare May 26, 2025 05:28

sgarg-CS added build and removed build labels May 27, 2025

sgarg-CS requested a review from itsankit-google May 30, 2025 04:56

itsankit-google requested changes May 30, 2025

View reviewed changes

sgarg-CS added 3 commits May 30, 2025 21:47

PLUGIN-1823: Rework

8b1f12c

Fix unit test for MySQLSinkTest

d0c15c0

Fix failing unit test for CloudSQLMySQLTest

ad6b3fe

itsankit-google reviewed Jun 2, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/db/sink/AbstractDBSink.java Outdated Show resolved Hide resolved

itsankit-google reviewed Jun 2, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/db/sink/AbstractDBSink.java Outdated Show resolved Hide resolved

itsankit-google reviewed Jun 2, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/db/source/AbstractDBSource.java Outdated Show resolved Hide resolved

itsankit-google reviewed Jun 2, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/db/source/AbstractDBSource.java Outdated Show resolved Hide resolved

itsankit-google reviewed Jun 2, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/db/ConnectionConfig.java Outdated Show resolved Hide resolved

itsankit-google reviewed Jun 2, 2025

View reviewed changes

cloudsql-mysql-plugin/src/test/java/io/cdap/plugin/cloudsql/mysql/CloudSQLMySQLSinkTest.java Show resolved Hide resolved

itsankit-google reviewed Jun 2, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/db/connector/AbstractDBSpecificConnector.java Outdated Show resolved Hide resolved

itsankit-google requested changes Jun 2, 2025

View reviewed changes

itsankit-google reviewed Jun 2, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/db/source/AbstractDBSource.java Outdated Show resolved Hide resolved

PLUGIN-1823: Rework

ff0cd0b

Move retry logic into a separate class: RetryUtils and add exception handling

itsankit-google reviewed Jun 3, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/util/RetryUtils.java Show resolved Hide resolved

itsankit-google reviewed Jun 3, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/db/source/AbstractDBSource.java Outdated Show resolved Hide resolved

itsankit-google reviewed Jun 3, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/util/RetryUtils.java Outdated Show resolved Hide resolved

Removed unused method and extra line

fc78d9c

itsankit-google reviewed Jun 4, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/db/sink/AbstractDBSink.java Outdated Show resolved Hide resolved

itsankit-google reviewed Jun 4, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/db/source/AbstractDBSource.java Outdated Show resolved Hide resolved

itsankit-google reviewed Jun 4, 2025

View reviewed changes

PLUGIN-1823: Rework

037a0d4

Moved all the retry constants to RetryUtils class, Added the methods to determine error type and error category methods from Error code and SQL State

PLUGIN-1823: Revert SQLException handling changes for validateSchema

a2bd3a9

itsankit-google reviewed Jun 5, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/util/RetryUtils.java Outdated Show resolved Hide resolved

itsankit-google reviewed Jun 5, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/db/action/AbstractDBArgumentSetter.java Outdated Show resolved Hide resolved

PLUGIN-1823: Add default value for external documentation

35537d7

itsankit-google reviewed Jun 5, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/util/RetryUtils.java Outdated Show resolved Hide resolved

itsankit-google reviewed Jun 5, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/util/RetryUtils.java Outdated Show resolved Hide resolved

itsmekumari added 5 commits June 19, 2025 22:28

error messages changes

b41551c

cloudsqlmysql changes

ba524f8

mysql changes

2d59b51

mssql changes

c31c021

cloudsqlpostgresql changes

852bcba

itsankit-google reviewed Jun 24, 2025

View reviewed changes

PLUGIN-1823: Rework

1eba47c

itsankit-google reviewed Jun 25, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/db/source/AbstractDBSource.java Outdated Show resolved Hide resolved

PLUGIN-1823: Create object only once.

5ef4f15

itsankit-google reviewed Jun 25, 2025

View reviewed changes

database-commons/src/main/java/io/cdap/plugin/db/sink/AbstractDBSink.java Outdated Show resolved Hide resolved

PLUGIN-1823: Remove instance variables from sub-class and change retu…

4970405

…rn types for overridden methods to base class

itsankit-google reviewed Jun 26, 2025

View reviewed changes

PLUGIN-1823: Remove getExternalDocumentationLink() method as it is no…

7c8815d

…t longer used now.

itsankit-google reviewed Jun 26, 2025

View reviewed changes

PLUGIN-1823: Removed empty lines

0b57ce6

		@@ -1,4 +1,4 @@
		errorMessageInvalidSourceDatabase=Error occurred while trying to get schema from database.Error message: 'Access denied for user '
		errorMessageInvalidSourceDatabase=Error occurred while trying to get schema from database.

PLUGIN-1823: Retrying all SQLTransientExceptions #597

Are you sure you want to change the base?

PLUGIN-1823: Retrying all SQLTransientExceptions #597

Conversation

sgarg-CS commented May 16, 2025 • edited by jira bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

google-cla bot commented May 16, 2025

Uh oh!

itsankit-google left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

itsankit-google commented May 30, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

itsankit-google left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

itsankit-google left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sgarg-CS commented Jun 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

itsankit-google left a comment

Choose a reason for hiding this comment

Uh oh!

sgarg-CS commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

itsankit-google commented Jun 5, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sgarg-CS commented May 16, 2025 •

edited by jira bot

Loading

itsankit-google left a comment •

edited

Loading

sgarg-CS commented Jun 5, 2025 •

edited

Loading