feat(datasource): Improve datasource connection test error messages (#559)

xxzuo · web-flow · commit 5334219cbd2a · 2026-02-03T10:01:39.000+08:00
diff --git a/datavines-connector/datavines-connector-plugins/datavines-connector-databend/src/main/java/io/datavines/connector/plugin/DatabendConnector.java b/datavines-connector/datavines-connector-plugins/datavines-connector-databend/src/main/java/io/datavines/connector/plugin/DatabendConnector.java
@@ -59,22 +59,20 @@ public ConnectorResponse testConnect(TestConnectionRequestParam param) {
         dataSourceInfo.loadClass();
         try (Connection con = DriverManager.getConnection(dataSourceInfo.getJdbcUrl(),
                 dataSourceInfo.getUser(), StringUtils.isEmpty(dataSourceInfo.getPassword()) ? null : dataSourceInfo.getPassword())) {
-            boolean result = (con!=null);
-            if (result) {
-                try {
-                    getMetadataDatabases(con);
-                } catch (Exception e) {
-                    logger.error("create connection error", e);
-                    return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(false).build();
-                }
-
-                con.close();
+            if (con != null) {
+                getMetadataDatabases(con);
             }
-
-            return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(true).build();
-        } catch (SQLException e) {
-            logger.error("create connection error", e);
-            return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(false).build();
+            return ConnectorResponse.builder()
+                    .status(ConnectorResponse.Status.SUCCESS)
+                    .result(true)
+                    .build();
+        } catch (Exception e) {
+            logger.error("test connect error", e);
+            return ConnectorResponse.builder()
+                    .status(ConnectorResponse.Status.ERROR)
+                    .result(false)
+                    .errorMsg(e.getMessage())
+                    .build();
         }
     }
 
diff --git a/datavines-connector/datavines-connector-plugins/datavines-connector-doris/src/main/java/io/datavines/connector/plugin/DorisConnector.java b/datavines-connector/datavines-connector-plugins/datavines-connector-doris/src/main/java/io/datavines/connector/plugin/DorisConnector.java
@@ -64,9 +64,12 @@ public ConnectorResponse testConnect(TestConnectionRequestParam param) {
             return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(result).build();
         } catch (SQLException e) {
             logger.error("test connect error, param is {} :", JSONUtils.toJsonString(param), e);
+            return ConnectorResponse.builder()
+                    .status(ConnectorResponse.Status.ERROR)
+                    .result(false)
+                    .errorMsg(e.getMessage())
+                    .build();
         }
-
-        return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(false).build();
     }
 
     @Override
diff --git a/datavines-connector/datavines-connector-plugins/datavines-connector-hive/src/main/java/io/datavines/connector/plugin/HiveConnector.java b/datavines-connector/datavines-connector-plugins/datavines-connector-hive/src/main/java/io/datavines/connector/plugin/HiveConnector.java
@@ -67,9 +67,12 @@ public ConnectorResponse testConnect(TestConnectionRequestParam param) {
             return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(result).build();
         } catch (SQLException e) {
             logger.error("test connect error, param is {} :", JSONUtils.toJsonString(param), e);
+            return ConnectorResponse.builder()
+                    .status(ConnectorResponse.Status.ERROR)
+                    .result(false)
+                    .errorMsg(e.getMessage())
+                    .build();
         }
-
-        return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(false).build();
     }
 
 }
diff --git a/datavines-connector/datavines-connector-plugins/datavines-connector-jdbc/src/main/java/io/datavines/connector/plugin/JdbcConnector.java b/datavines-connector/datavines-connector-plugins/datavines-connector-jdbc/src/main/java/io/datavines/connector/plugin/JdbcConnector.java
@@ -206,9 +206,12 @@ public ConnectorResponse testConnect(TestConnectionRequestParam param) {
             return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(result).build();
         } catch (SQLException e) {
             logger.error("test connect error, param is {} :", JSONUtils.toJsonString(param), e);
+            return ConnectorResponse.builder()
+                    .status(ConnectorResponse.Status.ERROR)
+                    .result(false)
+                    .errorMsg(e.getMessage())
+                    .build();
         }
-
-        return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(false).build();
     }
 
     private List<String> getPrimaryKeys(String catalog, String schema, String tableName, DatabaseMetaData metaData) {
diff --git a/datavines-connector/datavines-connector-plugins/datavines-connector-mongodb/src/main/java/io/datavines/connector/plugin/MongodbConnector.java b/datavines-connector/datavines-connector-plugins/datavines-connector-mongodb/src/main/java/io/datavines/connector/plugin/MongodbConnector.java
@@ -199,14 +199,21 @@ public ConnectorResponse testConnect(TestConnectionRequestParam param) {
         try {
             MongoClient mongoClient = getMongoClient(paramMap);
             if (mongoClient == null) {
-                return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(false).build();
+                return ConnectorResponse.builder()
+                        .status(ConnectorResponse.Status.ERROR)
+                        .result(false)
+                        .errorMsg("Failed to create MongoDB client")
+                        .build();
             }
             return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(true).build();
         } catch (Exception e) {
             logger.error(e.toString(), e);
+            return ConnectorResponse.builder()
+                    .status(ConnectorResponse.Status.ERROR)
+                    .result(false)
+                    .errorMsg(e.getMessage())
+                    .build();
         }
-
-        return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(false).build();
     }
 
     @Override
diff --git a/datavines-connector/datavines-connector-plugins/datavines-connector-presto/src/main/java/io/datavines/connector/plugin/PrestoConnector.java b/datavines-connector/datavines-connector-plugins/datavines-connector-presto/src/main/java/io/datavines/connector/plugin/PrestoConnector.java
@@ -78,22 +78,20 @@ public ConnectorResponse testConnect(TestConnectionRequestParam param) {
         }
 
         try (Connection con = DriverManager.getConnection(url, properties)) {
-            boolean result = (con!=null);
-            if (result) {
-                try {
-                    getMetadataDatabases(con);
-                } catch (Exception e) {
-                    logger.error("create connection error", e);
-                    return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(false).build();
-                }
-
-                con.close();
+            if (con != null) {
+                getMetadataDatabases(con);
             }
-
-            return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(true).build();
-        } catch (SQLException e) {
-            logger.error("create connection error", e);
-            return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(false).build();
+            return ConnectorResponse.builder()
+                    .status(ConnectorResponse.Status.SUCCESS)
+                    .result(true)
+                    .build();
+        } catch (Exception e) {
+            logger.error("test connect error", e);
+            return ConnectorResponse.builder()
+                    .status(ConnectorResponse.Status.ERROR)
+                    .result(false)
+                    .errorMsg(e.getMessage())
+                    .build();
         }
     }
 
diff --git a/datavines-connector/datavines-connector-plugins/datavines-connector-trino/src/main/java/io/datavines/connector/plugin/TrinoConnector.java b/datavines-connector/datavines-connector-plugins/datavines-connector-trino/src/main/java/io/datavines/connector/plugin/TrinoConnector.java
@@ -77,22 +77,20 @@ public ConnectorResponse testConnect(TestConnectionRequestParam param) {
         }
 
         try (Connection con = DriverManager.getConnection(url, properties)) {
-            boolean result = (con!=null);
-            if (result) {
-                try {
-                    getMetadataDatabases(con);
-                } catch (Exception e) {
-                    logger.error("create connection error", e);
-                    return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(false).build();
-                }
-
-                con.close();
+            if (con != null) {
+                getMetadataDatabases(con);
             }
-
-            return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(true).build();
-        } catch (SQLException e) {
-            logger.error("create connection error", e);
-            return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(false).build();
+            return ConnectorResponse.builder()
+                    .status(ConnectorResponse.Status.SUCCESS)
+                    .result(true)
+                    .build();
+        } catch (Exception e) {
+            logger.error("test connect error", e);
+            return ConnectorResponse.builder()
+                    .status(ConnectorResponse.Status.ERROR)
+                    .result(false)
+                    .errorMsg(e.getMessage())
+                    .build();
         }
     }
 
diff --git a/datavines-server/src/main/java/io/datavines/server/api/controller/DataSourceController.java b/datavines-server/src/main/java/io/datavines/server/api/controller/DataSourceController.java
@@ -16,9 +16,12 @@
  */
 package io.datavines.server.api.controller;
 
+import io.datavines.common.param.ConnectorResponse;
 import io.datavines.connector.api.ConnectorFactory;
+import io.datavines.core.entity.ResultMap;
 import io.datavines.server.api.dto.vo.Item;
 import io.datavines.common.param.TestConnectionRequestParam;
+import io.datavines.common.utils.StringUtils;
 import io.datavines.core.constant.DataVinesConstants;
 import io.datavines.core.aop.RefreshToken;
 import io.datavines.server.api.dto.bo.datasource.DataSourceCreate;
@@ -56,7 +59,30 @@ public class DataSourceController {
     @ApiOperation(value = "test connection")
     @PostMapping(value = "/test", consumes = MediaType.APPLICATION_JSON_VALUE)
     public Object testConnection(@Valid @RequestBody TestConnectionRequestParam param)  {
-        return dataSourceService.testConnect(param);
+        ConnectorResponse response = dataSourceService.testConnect(param);
+
+        ResultMap resultMap = new ResultMap();
+
+        if (response == null) {
+            return resultMap.fail().message("Connector response is null");
+        }
+
+        boolean isSuccess = response.getStatus() != null
+                && response.getStatus().isSuccess()
+                && Boolean.TRUE.equals(response.getResult());
+
+        if (isSuccess) {
+            return resultMap.success()
+                    .message("Connection test succeeded")
+                    .payload(true);
+        } else {
+            String errorMsg = StringUtils.isEmpty(response.getErrorMsg())
+                    ? "Connection failed"
+                    : response.getErrorMsg();
+            return resultMap.fail()
+                    .message(errorMsg)
+                    .payload(false);
+        }
     }
 
     @ApiOperation(value = "create datasource")
diff --git a/datavines-server/src/main/java/io/datavines/server/api/controller/ErrorDataStorageController.java b/datavines-server/src/main/java/io/datavines/server/api/controller/ErrorDataStorageController.java
@@ -16,10 +16,13 @@
  */
 package io.datavines.server.api.controller;
 
+import io.datavines.common.param.ConnectorResponse;
 import io.datavines.common.param.TestConnectionRequestParam;
+import io.datavines.common.utils.StringUtils;
 import io.datavines.connector.api.ConnectorFactory;
 import io.datavines.core.aop.RefreshToken;
 import io.datavines.core.constant.DataVinesConstants;
+import io.datavines.core.entity.ResultMap;
 import io.datavines.server.api.dto.bo.storage.ErrorDataStorageCreate;
 import io.datavines.server.api.dto.bo.storage.ErrorDataStoragePageParam;
 import io.datavines.server.api.dto.bo.storage.ErrorDataStorageUpdate;
@@ -52,7 +55,30 @@ public class ErrorDataStorageController {
     @ApiOperation(value = "test error data storage")
     @PostMapping(value = "/test", consumes = MediaType.APPLICATION_JSON_VALUE)
     public Object testConnection(@Valid @RequestBody TestConnectionRequestParam param)  {
-        return errorDataStorageService.testConnect(param);
+        ConnectorResponse response = errorDataStorageService.testConnect(param);
+
+        ResultMap resultMap = new ResultMap();
+
+        if (response == null) {
+            return resultMap.fail().message("Connector response is null");
+        }
+
+        boolean isSuccess = response.getStatus() != null
+                && response.getStatus().isSuccess()
+                && Boolean.TRUE.equals(response.getResult());
+
+        if (isSuccess) {
+            return resultMap.success()
+                    .message("Connection test succeeded")
+                    .payload(true);
+        } else {
+            String errorMsg = StringUtils.isEmpty(response.getErrorMsg())
+                    ? "Connection failed"
+                    : response.getErrorMsg();
+            return resultMap.fail()
+                    .message(errorMsg)
+                    .payload(false);
+        }
     }
 
     @ApiOperation(value = "create error data storage")
diff --git a/datavines-server/src/main/java/io/datavines/server/repository/service/DataSourceService.java b/datavines-server/src/main/java/io/datavines/server/repository/service/DataSourceService.java
@@ -20,6 +20,7 @@
 import com.baomidou.mybatisplus.extension.service.IService;
 import io.datavines.server.api.dto.bo.datasource.ExecuteRequest;
 import io.datavines.common.exception.DataVinesException;
+import io.datavines.common.param.ConnectorResponse;
 import io.datavines.common.param.TestConnectionRequestParam;
 import io.datavines.server.api.dto.bo.datasource.DataSourceCreate;
 import io.datavines.server.api.dto.bo.datasource.DataSourceUpdate;
@@ -31,7 +32,7 @@
 
 public interface DataSourceService extends IService<DataSource> {
 
-    boolean testConnect(TestConnectionRequestParam connectionParam);
+    ConnectorResponse testConnect(TestConnectionRequestParam connectionParam);
 
     long insert(DataSourceCreate dataSource);
 
diff --git a/datavines-server/src/main/java/io/datavines/server/repository/service/ErrorDataStorageService.java b/datavines-server/src/main/java/io/datavines/server/repository/service/ErrorDataStorageService.java
@@ -19,6 +19,7 @@
 
 import com.baomidou.mybatisplus.core.metadata.IPage;
 import com.baomidou.mybatisplus.extension.service.IService;
+import io.datavines.common.param.ConnectorResponse;
 import io.datavines.common.param.TestConnectionRequestParam;
 import io.datavines.core.exception.DataVinesServerException;
 import io.datavines.server.api.dto.bo.storage.ErrorDataStorageCreate;
@@ -31,7 +32,7 @@
 
 public interface ErrorDataStorageService extends IService<ErrorDataStorage> {
 
-    boolean testConnect(TestConnectionRequestParam connectionParam);
+    ConnectorResponse testConnect(TestConnectionRequestParam connectionParam);
 
     long create(ErrorDataStorageCreate tenantCreate) throws DataVinesServerException;
 
diff --git a/datavines-server/src/main/java/io/datavines/server/repository/service/impl/DataSourceServiceImpl.java b/datavines-server/src/main/java/io/datavines/server/repository/service/impl/DataSourceServiceImpl.java
@@ -73,10 +73,9 @@ public class DataSourceServiceImpl extends ServiceImpl<DataSourceMapper, DataSou
     private CommonTaskScheduleService commonTaskScheduleService;
 
     @Override
-    public boolean testConnect(TestConnectionRequestParam param) {
+    public ConnectorResponse testConnect(TestConnectionRequestParam param) {
         ConnectorFactory connectorFactory = PluginLoader.getPluginLoader(ConnectorFactory.class).getOrCreatePlugin(param.getType());
-        ConnectorResponse response = connectorFactory.getConnector().testConnect(param);
-        return (boolean)response.getResult();
+        return connectorFactory.getConnector().testConnect(param);
     }
 
     @Override
diff --git a/datavines-server/src/main/java/io/datavines/server/repository/service/impl/ErrorDataStorageServiceImpl.java b/datavines-server/src/main/java/io/datavines/server/repository/service/impl/ErrorDataStorageServiceImpl.java
@@ -51,10 +51,9 @@
 public class ErrorDataStorageServiceImpl extends ServiceImpl<ErrorDataStorageMapper, ErrorDataStorage> implements ErrorDataStorageService {
 
     @Override
-    public boolean testConnect(TestConnectionRequestParam param) {
+    public ConnectorResponse testConnect(TestConnectionRequestParam param) {
         ConnectorFactory connectorFactory = PluginLoader.getPluginLoader(ConnectorFactory.class).getOrCreatePlugin(param.getType());
-        ConnectorResponse response = connectorFactory.getConnector().testConnect(param);
-        return (boolean)response.getResult();
+        return connectorFactory.getConnector().testConnect(param);
     }
 
     @Override
diff --git a/datavines-ui/src/locale/en_US.ts b/datavines-ui/src/locale/en_US.ts
@@ -51,6 +51,7 @@ export default {
 
     confirm_text: 'OK',
     test_link: 'Test Connect',
+    test_link_success: 'Connection test succeeded',
     test_link_fail: 'Test Connect Failed',
 
     login_btn_text: 'Login',
diff --git a/datavines-ui/src/locale/zh_CN.ts b/datavines-ui/src/locale/zh_CN.ts
@@ -51,6 +51,7 @@ export default {
 
     confirm_text: '确认',
     test_link: '测试链接',
+    test_link_success: '连接测试成功',
     test_link_fail: '测试链接失败',
 
     login_btn_text: '登录',
diff --git a/datavines-ui/src/view/Main/ErrorDataManage/useAddErrorManage.tsx b/datavines-ui/src/view/Main/ErrorDataManage/useAddErrorManage.tsx
@@ -147,13 +147,19 @@ export const useAddErrorManage = (options: ModalProps) => {
                     type,
                     dataSourceParam: JSON.stringify(rest),
                 });
-                if (res) {
-                    message.success('Success!');
+                // 后端返回 ResultMap: { code, msg, data }
+                if (res?.data === true) {
+                    message.success(intl.formatMessage({ id: 'test_link_success' }));
                     setIsSuccessTest(true);
                 } else {
-                    message.error(intl.formatMessage({ id: 'test_link_fail' }));
+                    // 显示后端返回的详细错误信息
+                    const errorMsg = res?.msg || intl.formatMessage({ id: 'test_link_fail' });
+                    message.error(errorMsg);
                 }
             } catch (error: any) {
+                // 显示异常中的错误信息
+                const errorMsg = error?.msg || intl.formatMessage({ id: 'test_link_fail' });
+                message.error(errorMsg);
             } finally {
                 setLoading(false);
             }
diff --git a/datavines-ui/src/view/Main/Home/AddDataSource/index.tsx b/datavines-ui/src/view/Main/Home/AddDataSource/index.tsx
@@ -172,13 +172,19 @@ export const useAddDataSource = (options: ModalProps) => {
                     type,
                     dataSourceParam: JSON.stringify(rest),
                 });
-                if (res) {
-                    message.success('Success!');
+                // 后端返回 ResultMap: { code, msg, data }
+                if (res?.data === true) {
+                    message.success(intl.formatMessage({ id: 'test_link_success' }));
                     setIsSuccessTest(true);
                 } else {
-                    message.error(intl.formatMessage({ id: 'test_link_fail' }));
+                    // 显示后端返回的详细错误信息
+                    const errorMsg = res?.msg || intl.formatMessage({ id: 'test_link_fail' });
+                    message.error(errorMsg);
                 }
             } catch (error: any) {
+                // 显示异常中的错误信息
+                const errorMsg = error?.msg || intl.formatMessage({ id: 'test_link_fail' });
+                message.error(errorMsg);
             } finally {
                 setLoading(false);
             }

Original file line number	Diff line number	Diff line change
`@@ -64,9 +64,12 @@ public ConnectorResponse testConnect(TestConnectionRequestParam param) {`
`64`	`64`	`return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(result).build();`
`65`	`65`	`} catch (SQLException e) {`
`66`	`66`	`logger.error("test connect error, param is {} :", JSONUtils.toJsonString(param), e);`
	`67`	`+ return ConnectorResponse.builder()`
	`68`	`+ .status(ConnectorResponse.Status.ERROR)`
	`69`	`+ .result(false)`
	`70`	`+ .errorMsg(e.getMessage())`
	`71`	`+ .build();`
`67`	`72`	`}`
`68`		`-`
`69`		`- return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(false).build();`
`70`	`73`	`}`
`71`	`74`
`72`	`75`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -67,9 +67,12 @@ public ConnectorResponse testConnect(TestConnectionRequestParam param) {`
`67`	`67`	`return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(result).build();`
`68`	`68`	`} catch (SQLException e) {`
`69`	`69`	`logger.error("test connect error, param is {} :", JSONUtils.toJsonString(param), e);`
	`70`	`+ return ConnectorResponse.builder()`
	`71`	`+ .status(ConnectorResponse.Status.ERROR)`
	`72`	`+ .result(false)`
	`73`	`+ .errorMsg(e.getMessage())`
	`74`	`+ .build();`
`70`	`75`	`}`
`71`		`-`
`72`		`- return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(false).build();`
`73`	`76`	`}`
`74`	`77`
`75`	`78`	`}`
Original file line number	Diff line number	Diff line change
`@@ -206,9 +206,12 @@ public ConnectorResponse testConnect(TestConnectionRequestParam param) {`
`206`	`206`	`return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(result).build();`
`207`	`207`	`} catch (SQLException e) {`
`208`	`208`	`logger.error("test connect error, param is {} :", JSONUtils.toJsonString(param), e);`
	`209`	`+ return ConnectorResponse.builder()`
	`210`	`+ .status(ConnectorResponse.Status.ERROR)`
	`211`	`+ .result(false)`
	`212`	`+ .errorMsg(e.getMessage())`
	`213`	`+ .build();`
`209`	`214`	`}`
`210`		`-`
`211`		`- return ConnectorResponse.builder().status(ConnectorResponse.Status.SUCCESS).result(false).build();`
`212`	`215`	`}`
`213`	`216`
`214`	`217`	`private List<String> getPrimaryKeys(String catalog, String schema, String tableName, DatabaseMetaData metaData) {`