cache db was leaked

[laomo]

Summary
cache db was leaked.

Version
v2.2.2

Description
SQLiteConnectionPool: A SQLiteConnection object for database '/data/user/0/com.my.package/databases/cache.db' was leaked! Please fix your application to end transactions in progress properly and to close the database when it is no longer needed.

[martinbonnin]

Hi! Sorry for ultra late response. Can you share more details about how to reproduce this issue?

[lwasyl]

Hey @martinbonnin not OP but we also see these logs in UI tests. We do call

apolloClient.clearHttpCache()
apolloClient.clearNormalizedCache()

after each test to clear the state, we also interrupt all currently running flows (btw is there a better way to basically stop everything Apollo is doing?). However after this, it seems that database is still open, so it leaks between the tests. I poked around but couldn't find an API to close the database properly after using

[nhickf]

Hello @martinbonnin I encountered the same issue, is there any fix on this issue?

[BoD]

It appears this can happen when an SQLiteConnection is garbage collected, without its close() method having been called first - which Apollo Kotlin never calls.

In practice, these connections are held by the SQLDelight driver, which is held by the SqlNormalizedCacheFactory, which is held by the ApolloClient. I managed to reproduce by removing references to a client and calling System.gc().

We should propagate ApolloClient.close() to the SQLDelight driver.

I don't believe this error should actually be too worrisome, but in the meantime, it's a bit hacky, but there's a way to close your connections thanks to the configure callback:

// Keep a reference to your db
var sqliteDatabase: SupportSQLiteDatabase? = null

val apolloClient = ApolloClient.Builder()
    .normalizedCache(
        SqlNormalizedCacheFactory(
            this,
            configure = {
                sqliteDatabase = it
            }
        )
    )

and then when you've finished using your client:

apolloClient.close()
sqliteDatabase?.close()