Add CloudSQLMySQLErrorDetailsProvider

Author: psainics

cloudsql-mysql-plugin/src/e2e-test/features/sink/CloudMySqlRunTimeMacro.feature

@@ -142,7 +142,9 @@ Feature: CloudMySql Sink - Run time scenarios (macro)
     Then Enter runtime argument value "invalidTablename" for key "invalidTablename"
     Then Run the Pipeline in Runtime with runtime arguments
     Then Wait till pipeline is in running state
+    And Open and capture logs
     And Verify the pipeline status is "Failed"
+    And Close the pipeline logs
     Then Open Pipeline logs and verify Log entries having below listed Level and Message:
       | Level | Message                                  |
       | ERROR | errorLogsMessageInvalidTableName         |
@@ -181,7 +183,9 @@ Feature: CloudMySql Sink - Run time scenarios (macro)
     Then Enter runtime argument value "invalidPassword" for key "Password"
     Then Run the Pipeline in Runtime with runtime arguments
     Then Wait till pipeline is in running state
+    And Open and capture logs
     And Verify the pipeline status is "Failed"
+    And Close the pipeline logs
     Then Open Pipeline logs and verify Log entries having below listed Level and Message:
       | Level | Message                                  |
       | ERROR | errorLogsMessageInvalidCredentials       |

cloudsql-mysql-plugin/src/e2e-test/features/source/CloudMySqlRunTime.feature

@@ -224,7 +224,9 @@ Feature: CloudMySql Source - Run time scenarios
     Then Deploy the pipeline
     Then Run the Pipeline in Runtime
     Then Wait till pipeline is in running state
+    And Open and capture logs
     And Verify the pipeline status is "Failed"
+    And Close the pipeline logs
     Then Open Pipeline logs and verify Log entries having below listed Level and Message:
       | Level | Message                                  |
       | ERROR | errorLogsMessageInvalidBoundingQuery     |

cloudsql-mysql-plugin/src/main/java/io/cdap/plugin/cloudsql/mysql/CloudSQLMySQLErrorDetailsProvider.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright © 2024 Cask Data, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package io.cdap.plugin.cloudsql.mysql;
+
+
+import io.cdap.cdap.api.exception.ErrorType;
+import io.cdap.plugin.db.DBErrorDetailsProvider;
+
+/**
+ * A custom ErrorDetailsProvider for CloudSQL MySQL plugins.
+ */
+public class CloudSQLMySQLErrorDetailsProvider extends DBErrorDetailsProvider {
+
+  @Override
+  protected String getExternalDocumentationLink() {
+    return "https://dev.mysql.com/doc/mysql-errors/9.0/en/ ,https://cloud.google.com/sql/docs/mysql/error-messages";
+  }
+
+  @Override
+  protected ErrorType getErrorTypeFromErrorCode(int errorCode) {
+    // https://dev.mysql.com/doc/refman/9.0/en/error-message-elements.html#error-code-ranges
+    if (errorCode >= 1000 && errorCode <= 5999) {
+      return ErrorType.USER;
+    } else if (errorCode >= 10000 && errorCode <= 51999) {
+      // SYSTEM errors: Enterprise and user-defined custom error messages
+      return ErrorType.SYSTEM;
+    } else {
+      // UNKNOWN errors: Anything outside defined range
+      return ErrorType.UNKNOWN;
+    }
+  }
+}

cloudsql-mysql-plugin/src/main/java/io/cdap/plugin/cloudsql/mysql/CloudSQLMySQLSink.java

@@ -103,6 +103,11 @@ String getDbColumns() {
     return dbColumns;
   }
 
+  @Override
+  protected String getErrorDetailsProviderClassName() {
+    return CloudSQLMySQLErrorDetailsProvider.class.getName();
+  }
+
   @Override
   protected LineageRecorder getLineageRecorder(BatchSinkContext context) {
     String host;

cloudsql-mysql-plugin/src/main/java/io/cdap/plugin/cloudsql/mysql/CloudSQLMySQLSource.java

@@ -127,6 +127,11 @@ protected SchemaReader getSchemaReader() {
     return new MysqlSchemaReader(null, cloudsqlMysqlSourceConfig.getConnectionArguments());
   }
 
+  @Override
+  protected String getErrorDetailsProviderClassName() {
+    return CloudSQLMySQLErrorDetailsProvider.class.getName();
+  }
+
   /** CloudSQL MySQL source config. */
   public static class CloudSQLMySQLSourceConfig extends AbstractDBSpecificSourceConfig {