Skip to content

fix(jdbc): close metadata statements through closeStatementOnClose (#119) #127

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

Merged
magnusp merged 1 commit into from
Oct 22, 2026
Merged

fix(jdbc): close metadata statements through closeStatementOnClose (#119) #127

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: 13 additions & 3 deletions libsql-jdbc/src/main/java/com/github/magnusp/libsql/jdbc/LibsqlDatabaseMetaData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.function.UnaryOperator;
import java.util.regex.Pattern;

public class LibsqlDatabaseMetaData implements DatabaseMetaData {
Expand Down Expand Up @@ -285,10 +286,17 @@ public boolean supportsTransactionIsolationLevel(int level) throws SQLException
public boolean dataDefinitionIgnoredInTransactions() throws SQLException { return false; }

private ResultSet executeMetadataQuery(String sql) throws SQLException {
return executeMetadataQuery(sql, sql, result -> result);
}

private ResultSet executeMetadataQuery(
String sql, String originSql, UnaryOperator<StmtResult> transform) throws SQLException {
LibsqlStatement statement = connection.createStatementInternal();
try {
statement.closeOnCompletion();
return statement.executeQuery(sql);
StmtResult result = transform.apply(connection.executeStatement(new Stmt(sql)));
LibsqlResultSet resultSet = new LibsqlResultSet(statement, result, originSql, true);
statement.assignResultSet(resultSet, true);
return resultSet;
} catch (SQLException e) {
statement.close();
throw e;
Expand Down Expand Up @@ -340,7 +348,9 @@ public ResultSet getColumns(String catalog, String schemaPattern, String tableNa
+ " AND m.name LIKE '" + escapeLiteral(tablePattern) + "' ESCAPE '\\'"
+ " AND p.name LIKE '" + escapeLiteral(columnPattern) + "' ESCAPE '\\'"
+ " ORDER BY m.name, p.cid";
return new LibsqlResultSet(null, columnsResult(connection.executeStatement(new Stmt(sql))));
// getColumns synthesizes its column labels, so the raw SQL must not drive column-origin
// resolution for the result set.
return executeMetadataQuery(sql, null, LibsqlDatabaseMetaData::columnsResult);
}

private static StmtResult columnsResult(StmtResult raw) {
Expand Down
84 changes: 44 additions & 40 deletions libsql-jdbc/src/test/java/com/github/magnusp/libsql/jdbc/LibsqlDatabaseMetaDataTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
import com.github.magnusp.libsql.hrana.codec.StmtResult;
import com.github.magnusp.libsql.hrana.codec.Value;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;

import java.sql.DatabaseMetaData;
import java.sql.ResultSet;
Expand All @@ -15,8 +18,10 @@
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Stream;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.params.provider.Arguments.arguments;

class LibsqlDatabaseMetaDataTest {

Expand All @@ -31,17 +36,6 @@ void getTablesClosesResultSetWhenStatementCloses() throws SQLException {
assertThat(resultSet.isClosed()).isTrue();
}

@Test
void getTablesResultSetClosesItsStatement() throws SQLException {
LibsqlDatabaseMetaData metadata = new LibsqlDatabaseMetaData(new RecordingConnection(emptyResult()));

ResultSet resultSet = metadata.getTables(null, null, null, null);
LibsqlStatement statement = (LibsqlStatement) resultSet.getStatement();
resultSet.close();

assertThat(statement.isClosed()).isTrue();
}

@Test
void escapesSingleQuoteInTableNamePattern() throws SQLException {
RecordingConnection connection = new RecordingConnection(emptyResult());
Expand Down Expand Up @@ -150,43 +144,53 @@ void getTableTypesReturnsEveryXerialTableType() throws SQLException {
.containsExactlyInAnyOrder("TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY");
}

@Test
void eachMetadataMethodClosesTheStatementThatProducedItsResultSet() throws SQLException {
@ParameterizedTest(name = "{0}")
@MethodSource("metadataQueries")
void closesStatementWithoutCloseOnCompletion(String method, MetadataCall call) throws SQLException {
LibsqlDatabaseMetaData metadata = new LibsqlDatabaseMetaData(new RecordingConnection(emptyResult()));
List<MetadataQuery> queries = List.of(
new MetadataQuery("getSchemas", metadata::getSchemas),
new MetadataQuery("getSchemas(catalog, pattern)", () -> metadata.getSchemas(null, null)),
new MetadataQuery("getCatalogs", metadata::getCatalogs),
new MetadataQuery("getTypeInfo", metadata::getTypeInfo),
new MetadataQuery("getImportedKeys", () -> metadata.getImportedKeys(null, null, "t")),
new MetadataQuery("getExportedKeys", () -> metadata.getExportedKeys(null, null, "t")),
new MetadataQuery(
"getCrossReference",
() -> metadata.getCrossReference(null, null, "parent", null, null, "child")),
new MetadataQuery(
"getIndexInfo", () -> metadata.getIndexInfo(null, null, "t", false, false)));

List<String> leakedMethods = new ArrayList<>();
for (MetadataQuery query : queries) {
ResultSet resultSet = query.action().execute();
LibsqlStatement statement = (LibsqlStatement) resultSet.getStatement();
resultSet.close();
if (!statement.isClosed()) {
leakedMethods.add(query.name());
}
statement.close();
}

assertThat(leakedMethods).isEmpty();
ResultSet resultSet = call.execute(metadata);
assertThat(resultSet.getStatement())
.as("%s must expose the statement that produced it", method)
.isInstanceOf(LibsqlStatement.class);
LibsqlStatement statement = (LibsqlStatement) resultSet.getStatement();
assertThat(statement.isCloseOnCompletion())
.as("%s must not rely on closeOnCompletion to close its statement", method)
.isFalse();

resultSet.close();

assertThat(statement.isClosed())
.as("%s must close its statement when the result set closes", method)
.isTrue();
}

static Stream<Arguments> metadataQueries() {
return Stream.of(
arguments("getTables", (MetadataCall) m -> m.getTables(null, null, null, null)),
arguments("getColumns", (MetadataCall) m -> m.getColumns(null, null, "t", null)),
arguments("getPrimaryKeys", (MetadataCall) m -> m.getPrimaryKeys(null, null, "t")),
arguments("getTableTypes", (MetadataCall) LibsqlDatabaseMetaData::getTableTypes),
arguments("getSchemas", (MetadataCall) LibsqlDatabaseMetaData::getSchemas),
arguments("getSchemas(catalog, schemaPattern)", (MetadataCall) m -> m.getSchemas(null, null)),
arguments("getCatalogs", (MetadataCall) LibsqlDatabaseMetaData::getCatalogs),
arguments("getTypeInfo", (MetadataCall) LibsqlDatabaseMetaData::getTypeInfo),
arguments("getImportedKeys", (MetadataCall) m -> m.getImportedKeys(null, null, "t")),
arguments("getExportedKeys", (MetadataCall) m -> m.getExportedKeys(null, null, "t")),
arguments(
"getCrossReference",
(MetadataCall)
m -> m.getCrossReference(null, null, "parent", null, null, "child")),
arguments(
"getIndexInfo",
(MetadataCall) m -> m.getIndexInfo(null, null, "t", false, false)));
}

@FunctionalInterface
private interface MetadataCall {
ResultSet execute() throws SQLException;
ResultSet execute(LibsqlDatabaseMetaData metadata) throws SQLException;
}

private record MetadataQuery(String name, MetadataCall action) {}

@Test
void getColumnsReportsDeclaredTypesSizesNullabilityAndAutoIncrement() throws SQLException {
LibsqlDatabaseMetaData metadata = new LibsqlDatabaseMetaData(new StmtResultConnection(columnMetadataRows()));
Expand Down
Loading