fix(dameng): handle DBMS_OUTPUT messages safely
This commit is contained in:
4 files changed
+430
-13
No files matched your search
@@ -28,6 +28,11 @@ import java.sql.DriverManager;
|
||||
import java.sql.PreparedStatement;
|
||||
import java.sql.ResultSet;
|
||||
import java.sql.SQLException;
|
||||
import java.sql.SQLFeatureNotSupportedException;
|
||||
import java.sql.SQLNonTransientConnectionException;
|
||||
import java.sql.SQLRecoverableException;
|
||||
import java.sql.SQLSyntaxErrorException;
|
||||
import java.sql.SQLTransientConnectionException;
|
||||
import java.sql.SQLXML;
|
||||
import java.sql.Statement;
|
||||
import java.sql.Types;
|
||||
@@ -102,6 +107,77 @@ public final class DamengAgent extends AbstractJdbcAgent {
|
||||
connectedUsername = params.getUsername();
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void afterPhysicalConnect(ConnectParams params, Connection connection) throws SQLException {
|
||||
try (Statement statement = connection.createStatement()) {
|
||||
statement.execute("BEGIN DBMS_OUTPUT.ENABLE(1000000); END;");
|
||||
} catch (SQLException error) {
|
||||
if (!isIgnorableDbmsOutputError(error)) {
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private static boolean isIgnorableDbmsOutputError(SQLException error) {
|
||||
for (Throwable current = error; current != null; current = current.getCause()) {
|
||||
if (current instanceof SQLException sqlError) {
|
||||
for (SQLException candidate = sqlError; candidate != null; candidate = candidate.getNextException()) {
|
||||
if (isConnectionError(candidate)) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
for (Throwable current = error; current != null; current = current.getCause()) {
|
||||
if (current instanceof SQLException sqlError) {
|
||||
for (SQLException candidate = sqlError; candidate != null; candidate = candidate.getNextException()) {
|
||||
if (candidate instanceof SQLFeatureNotSupportedException || candidate instanceof SQLSyntaxErrorException) {
|
||||
return true;
|
||||
}
|
||||
String sqlState = candidate.getSQLState();
|
||||
if ("0A000".equalsIgnoreCase(sqlState)
|
||||
|| "42000".equalsIgnoreCase(sqlState)
|
||||
|| "42501".equalsIgnoreCase(sqlState)) {
|
||||
return true;
|
||||
}
|
||||
String message = candidate.getMessage();
|
||||
if (message != null && isDbmsOutputUnavailableMessage(message.toLowerCase(Locale.ROOT))) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
private static boolean isConnectionError(SQLException error) {
|
||||
String sqlState = error.getSQLState();
|
||||
return error instanceof SQLNonTransientConnectionException
|
||||
|| error instanceof SQLRecoverableException
|
||||
|| error instanceof SQLTransientConnectionException
|
||||
|| (sqlState != null && sqlState.toUpperCase(Locale.ROOT).startsWith("08"));
|
||||
}
|
||||
|
||||
private static boolean isDbmsOutputUnavailableMessage(String message) {
|
||||
if (!message.contains("dbms_output")) {
|
||||
return false;
|
||||
}
|
||||
return message.contains("权限")
|
||||
|| message.contains("privilege")
|
||||
|| message.contains("permission")
|
||||
|| message.contains("access denied")
|
||||
|| message.contains("not authorized")
|
||||
|| message.contains("不支持")
|
||||
|| message.contains("unsupported")
|
||||
|| message.contains("not supported")
|
||||
|| message.contains("不存在")
|
||||
|| message.contains("not exist")
|
||||
|| message.contains("not found")
|
||||
|| message.contains("未找到")
|
||||
|| message.contains("undefined")
|
||||
|| message.contains("未定义");
|
||||
}
|
||||
|
||||
/**
|
||||
* The DM JDBC driver writes a banner to {@code System.out} during
|
||||
* {@code Class.forName} / driver initialization. This corrupts the
|
||||
@@ -1040,13 +1116,38 @@ public final class DamengAgent extends AbstractJdbcAgent {
|
||||
sql,
|
||||
schema,
|
||||
this::setSchemaSQL,
|
||||
() -> "",
|
||||
options.getMaxRows(),
|
||||
options.getFetchSize(),
|
||||
options.getTimeoutSecs(),
|
||||
this::resultValue
|
||||
this::resultValue,
|
||||
DamengAgent::statementPrintMessages
|
||||
);
|
||||
}
|
||||
|
||||
static List<String> statementPrintMessages(Statement statement) {
|
||||
try {
|
||||
Object target = statement;
|
||||
Method method;
|
||||
try {
|
||||
method = statement.getClass().getMethod("getPrintMsg");
|
||||
} catch (NoSuchMethodException ignored) {
|
||||
// Pooled connections expose a Hikari proxy rather than DmdbStatement directly.
|
||||
Class<?> damengStatementClass = Class.forName("dm.jdbc.driver.DmdbStatement");
|
||||
target = statement.unwrap(damengStatementClass);
|
||||
method = damengStatementClass.getMethod("getPrintMsg");
|
||||
}
|
||||
Object value = method.invoke(target);
|
||||
if (!(value instanceof String)) {
|
||||
return List.of();
|
||||
}
|
||||
String message = (String) value;
|
||||
return message.isEmpty() ? List.of() : message.lines().toList();
|
||||
} catch (Exception ignored) {
|
||||
return List.of();
|
||||
}
|
||||
}
|
||||
|
||||
private QueryResult executeExplainQuery(String sql, String schema, ExecuteQueryOptions options) {
|
||||
return explainQueryResult(sql, schema, options.getTimeoutSecs(), options.getMaxRows());
|
||||
}
|
||||
@@ -1139,7 +1240,8 @@ public final class DamengAgent extends AbstractJdbcAgent {
|
||||
schema,
|
||||
this::setSchemaSQL,
|
||||
options,
|
||||
this::resultValue
|
||||
this::resultValue,
|
||||
DamengAgent::statementPrintMessages
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
@@ -12,11 +12,22 @@ import com.dbx.agent.test.JdbcAgentFake;
|
||||
import com.dbx.agent.test.TestSupport;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import java.lang.reflect.InvocationHandler;
|
||||
import java.lang.reflect.Method;
|
||||
import java.lang.reflect.Proxy;
|
||||
import java.sql.Connection;
|
||||
import java.sql.SQLException;
|
||||
import java.sql.SQLFeatureNotSupportedException;
|
||||
import java.sql.SQLTransientConnectionException;
|
||||
import java.sql.Statement;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||
import static org.junit.jupiter.api.Assertions.assertNull;
|
||||
import static org.junit.jupiter.api.Assertions.assertSame;
|
||||
import static org.junit.jupiter.api.Assertions.assertThrows;
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
|
||||
@@ -47,6 +58,80 @@ class DamengAgentTest extends JdbcFakeExecutionBehaviorTest {
|
||||
assertEquals(List.of("executeQuery"), JdbcAgentFake.calls);
|
||||
}
|
||||
|
||||
@Test
|
||||
void physicalConnectionsEnableDbmsOutputWithoutChangingUserSql() throws Exception {
|
||||
List<String> executedSql = new ArrayList<>();
|
||||
DamengAgent agent = new DamengAgent();
|
||||
|
||||
agent.afterPhysicalConnect(null, printMessageConnection(null, executedSql));
|
||||
|
||||
assertEquals(List.of("BEGIN DBMS_OUTPUT.ENABLE(1000000); END;"), executedSql);
|
||||
}
|
||||
|
||||
@Test
|
||||
void physicalConnectionsIgnoreUnsupportedOrRestrictedDbmsOutput() {
|
||||
DamengAgent agent = new DamengAgent();
|
||||
|
||||
assertDoesNotThrow(() -> agent.afterPhysicalConnect(
|
||||
null,
|
||||
failingDbmsOutputConnection(new SQLFeatureNotSupportedException("unsupported", "0A000"))
|
||||
));
|
||||
assertDoesNotThrow(() -> agent.afterPhysicalConnect(
|
||||
null,
|
||||
failingDbmsOutputConnection(new SQLException("permission denied", "42000"))
|
||||
));
|
||||
}
|
||||
|
||||
@Test
|
||||
void physicalConnectionsPropagateConnectionFailures() {
|
||||
DamengAgent agent = new DamengAgent();
|
||||
SQLException transientFailure = new SQLTransientConnectionException("connection closed");
|
||||
SQLException sqlStateFailure = new SQLException("connection failure", "08006");
|
||||
SQLException wrappedFailure = new SQLException("permission denied", "42000");
|
||||
wrappedFailure.initCause(new SQLTransientConnectionException("connection closed"));
|
||||
|
||||
assertSame(transientFailure, assertThrows(
|
||||
SQLException.class,
|
||||
() -> agent.afterPhysicalConnect(null, failingDbmsOutputConnection(transientFailure))
|
||||
));
|
||||
assertSame(sqlStateFailure, assertThrows(
|
||||
SQLException.class,
|
||||
() -> agent.afterPhysicalConnect(null, failingDbmsOutputConnection(sqlStateFailure))
|
||||
));
|
||||
assertSame(wrappedFailure, assertThrows(
|
||||
SQLException.class,
|
||||
() -> agent.afterPhysicalConnect(null, failingDbmsOutputConnection(wrappedFailure))
|
||||
));
|
||||
}
|
||||
|
||||
@Test
|
||||
void physicalConnectionsPropagateUnrelatedSetupFailures() {
|
||||
DamengAgent agent = new DamengAgent();
|
||||
SQLException failure = new SQLException("resource busy", "HY000");
|
||||
|
||||
assertSame(failure, assertThrows(
|
||||
SQLException.class,
|
||||
() -> agent.afterPhysicalConnect(null, failingDbmsOutputConnection(failure))
|
||||
));
|
||||
}
|
||||
|
||||
@Test
|
||||
void executeQueryReturnsDamengPrintMessagesForLogOnlyProcedures() {
|
||||
List<String> executedSql = new ArrayList<>();
|
||||
DamengAgent agent = new DamengAgent();
|
||||
TestSupport.setPrivateConnection(agent, printMessageConnection("first\n中文日志\n", executedSql));
|
||||
|
||||
QueryResult result = agent.executeQuery(
|
||||
"CALL LOG_ONLY_PROCEDURE('input')",
|
||||
null,
|
||||
new ExecuteQueryOptions()
|
||||
);
|
||||
|
||||
assertEquals(List.of("Message"), result.getColumns());
|
||||
assertEquals(List.of(List.of("first"), List.of("中文日志")), result.getRows());
|
||||
assertEquals(List.of("CALL LOG_ONLY_PROCEDURE('input')"), executedSql);
|
||||
}
|
||||
|
||||
@Test
|
||||
void executeQueryPageReturnsPlanRowsForExplainStatements() {
|
||||
DamengAgent agent = new DamengAgent();
|
||||
@@ -274,4 +359,67 @@ class DamengAgentTest extends JdbcFakeExecutionBehaviorTest {
|
||||
assertTrue(query.sql().endsWith("LIMIT ? OFFSET ?"));
|
||||
assertEquals(List.of("REPORTING", "VIEW", "MATERIALIZED_VIEW", "%S%A%L%E%S%", 10, 30), query.args());
|
||||
}
|
||||
|
||||
private static Connection printMessageConnection(String printMessage, List<String> executedSql) {
|
||||
return statementConnection(printMessage, executedSql, null);
|
||||
}
|
||||
|
||||
private static Connection failingDbmsOutputConnection(SQLException failure) {
|
||||
return statementConnection(null, new ArrayList<>(), failure);
|
||||
}
|
||||
|
||||
private static Connection statementConnection(
|
||||
String printMessage,
|
||||
List<String> executedSql,
|
||||
SQLException executeFailure
|
||||
) {
|
||||
InvocationHandler statementHandler = (Object unused, Method method, Object[] args) -> {
|
||||
switch (method.getName()) {
|
||||
case "execute":
|
||||
if (executeFailure != null) {
|
||||
throw executeFailure;
|
||||
}
|
||||
executedSql.add((String) args[0]);
|
||||
return false;
|
||||
case "getPrintMsg":
|
||||
return printMessage;
|
||||
case "getUpdateCount":
|
||||
return -1;
|
||||
default:
|
||||
return defaultValue(method.getReturnType());
|
||||
}
|
||||
};
|
||||
Statement statement = (Statement) Proxy.newProxyInstance(
|
||||
DamengAgentTest.class.getClassLoader(),
|
||||
new Class<?>[]{Statement.class, PrintMessageStatement.class},
|
||||
statementHandler
|
||||
);
|
||||
InvocationHandler connectionHandler = (Object unused, Method method, Object[] args) -> {
|
||||
if (method.getName().equals("createStatement")) {
|
||||
return statement;
|
||||
}
|
||||
return defaultValue(method.getReturnType());
|
||||
};
|
||||
return (Connection) Proxy.newProxyInstance(
|
||||
DamengAgentTest.class.getClassLoader(),
|
||||
new Class<?>[]{Connection.class},
|
||||
connectionHandler
|
||||
);
|
||||
}
|
||||
|
||||
private static Object defaultValue(Class<?> type) {
|
||||
if (type == Boolean.TYPE) return false;
|
||||
if (type == Byte.TYPE) return (byte) 0;
|
||||
if (type == Short.TYPE) return (short) 0;
|
||||
if (type == Integer.TYPE) return 0;
|
||||
if (type == Long.TYPE) return 0L;
|
||||
if (type == Float.TYPE) return 0f;
|
||||
if (type == Double.TYPE) return 0.0d;
|
||||
if (type == Character.TYPE) return '\0';
|
||||
return null;
|
||||
}
|
||||
|
||||
public interface PrintMessageStatement {
|
||||
String getPrintMsg();
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user