Skip to content

fix(jdbc): escape quoted table names in getIndexInfo - #93

Merged
magnusp merged 1 commit into
mainfrom
fix/50-indexinfo-escaping
Oct 22, 2026
Merged

magnusp merged 1 commit into
mainfrom
fix/50-indexinfo-escaping

Conversation

@magnusp

@magnusp magnusp commented Oct 22, 2026

Copy link
Copy Markdown
Owner

Part of #50. Covers defect (3), getIndexInfo table-name escaping, only. It does not change getMetaData caching (defect 4), which remains for the final PR under #50.

What changed

  • LibsqlDatabaseMetaData.getIndexInfo now escapes the table name with the existing escapeLiteral helper (single quotes doubled) before interpolating it into both the TABLE_NAME literal and the pragma_index_list(...) argument.
  • Added LibsqlDatabaseMetaDataTest.getIndexInfoRoundTripsQuotedTableName. The test calls getIndexInfo(null, null, "t'x", false, false) end to end against a connection that interprets the generated SQL string literals the way SQLite does. It asserts the returned row carries TABLE_NAME = "t'x", the expected index name, and the expected column name.

Contract decision

Parity with xerial 3.53.4.0 JDBC3DatabaseMetaData.getIndexInfo (src/main/java/org/sqlite/jdbc3/JDBC3DatabaseMetaData.java:1525), which applies its escape(table) helper to both places the table name is interpolated. This implementation uses the existing escapeLiteral, whose quote-doubling rule is identical. The Hrana transport and sqld require no different shape. No deviation.

Evidence

The new test fails on the pre-fix code:

./mvnw -q -pl libsql-jdbc -am test -Dtest=LibsqlDatabaseMetaDataTest -Dsurefire.failIfNoSpecifiedTests=false
[ERROR] Tests run: 13, Failures: 0, Errors: 1, Skipped: 0
[ERROR] LibsqlDatabaseMetaDataTest.getIndexInfoRoundTripsQuotedTableName:61
        » SQL java.sql.SQLException: syntax error after table-name literal

The same test passes after the fix:

./mvnw -pl libsql-jdbc -am test -Dtest=LibsqlDatabaseMetaDataTest -Dsurefire.failIfNoSpecifiedTests=false
Tests run: 13, Failures: 0, Errors: 0, Skipped: 0
BUILD SUCCESS

Full module run:

./mvnw -pl libsql-jdbc -am test
Tests run: 169, Failures: 0, Errors: 0, Skipped: 0
BUILD SUCCESS

Regression guard:

./mvnw -pl libsql-conformance -am verify
Tests run: 115, Failures: 0, Errors: 0, Skipped: 1
BUILD SUCCESS

Formatting:

./mvnw spotless:apply
BUILD SUCCESS

libsql-itests was not required by the #50 Steering verification steps and was not run. The conformance suite does not currently call getIndexInfo; it ran as a regression guard for the surrounding metadata behavior.

Deviations

None.

Defects covered

  • (1) getTableTypes completeness.
  • (2) Statement leaks in the listed metadata methods.
  • (3) getIndexInfo table-name escaping.
  • (4) getMetaData caching.

Files touched

  • libsql-jdbc/src/main/java/com/github/magnusp/libsql/jdbc/LibsqlDatabaseMetaData.java
  • libsql-jdbc/src/test/java/com/github/magnusp/libsql/jdbc/LibsqlDatabaseMetaDataTest.java

Out-of-scope defects noticed

  • Defect (4), LibsqlConnection.getMetaData returning an uncached object, is still present and is intentionally left for the final PR.
  • No other out-of-scope defect was found in the getIndexInfo path.

@magnusp
magnusp merged commit 2479fe6 into main Oct 22, 2026
5 checks passed
@magnusp
magnusp deleted the fix/50-indexinfo-escaping branch October 22, 2026 00:13
magnusp added a commit that referenced this pull request Oct 22, 2026
Closes #50

Part of #54.

## What changed

`LibsqlConnection.getMetaData()` now creates `LibsqlDatabaseMetaData` on
first use and returns the same instance for the lifetime of the
connection. Separate connections get separate instances. A closed
connection still throws. The method Javadoc documents the caching
contract.

The behavior test
`LibsqlConnectionTest#getMetaDataIsCachedPerConnection` pins both
halves: repeated calls on one connection return the same object, and
another connection returns a different object.

## Contract decision

Parity with xerial sqlite-jdbc 3.53.4.0.
`SQLiteConnection.getSQLiteDatabaseMetaData()` caches its metadata
object in a `meta` field and `getMetaData()` delegates to it, so the
same instance is returned per connection. This change matches that
behavior. No Hrana or sqld constraint makes parity impossible.

## Evidence

Failing before the fix:

```
./mvnw -q -pl libsql-jdbc -am -Dtest=LibsqlConnectionTest#getMetaDataIsCachedPerConnection -Dsurefire.failIfNoSpecifiedTests=false test
```

```
[ERROR] Tests run: 1, Failures: 1, Errors: 0, Skipped: 0
java.lang.AssertionError:
Expecting actual:
  com.github.magnusp.libsql.jdbc.LibsqlDatabaseMetaData@58c34bb3
and:
  com.github.magnusp.libsql.jdbc.LibsqlDatabaseMetaData@56a4479a
to refer to the same object
```

Passing after the fix:

```
./mvnw -q -pl libsql-jdbc -am -Dtest=LibsqlConnectionTest#getMetaDataIsCachedPerConnection -Dsurefire.failIfNoSpecifiedTests=false test
```

No failures (exit 0).

Full module suite after the fix:

```
./mvnw -pl libsql-jdbc -am test
```

```
Tests run: 170, Failures: 0, Errors: 0, Skipped: 0
BUILD SUCCESS
```

Formatting:

```
./mvnw spotless:apply
BUILD SUCCESS
```

`libsql-itests` and `libsql-conformance` were not run: the #50 Steering
evidence asks for `./mvnw -pl libsql-jdbc -am test` and `./mvnw
spotless:apply`, and this change touches no live-sqld or conformance
path.

## Deviations

None.

## Defect coverage

This is defect (4) of the four sequenced defects under #50:
`getMetaData` caching. It does not reopen the earlier three defects,
which were delivered in #90 (`getTableTypes`), #91 (statement leaks),
and #93 (`getIndexInfo` escaping).

Files touched:

-
`libsql-jdbc/src/main/java/com/github/magnusp/libsql/jdbc/LibsqlConnection.java`
-
`libsql-jdbc/src/test/java/com/github/magnusp/libsql/jdbc/LibsqlConnectionTest.java`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant