Allow databases to be created from compressed asset files [146911060]

Fixed

Feature Request

androidx-bug-bounty

Status Update

No update yet.

Description

jo...@fueledbycaffeine.com

created issue #1

Dec 27, 2019 09:58PM

Component used: Room
Version used: 2.2.3

We got the ability to create room databases from assets or other files in

b/62185732

which is great. However, in my app I am packaging a GZipped sqlite database to save download space. The database is read-only and contains a moderate amount of data, so the APK size savings is about 1MB. Another app I work on that could benefit from this packages a 10MB sqlite database which gzips down to 3MB.

My current workaround is to manually decompress the gzipped asset into the application's database directory, but there's no reason that the room database builder couldn't handle this step on it's own.

Comments

zh...@gmail.com <zh...@gmail.com> #2Dec 31, 2019 02:22AM

For Kotlin 2.0 and KSP 2.0 the Cannot change attributes of configuration ':composeApp:debugFrameworkIosX64' after it has been locked for mutation really seems like a KSP issue. You should file a bug in their repository with a sample app if possible.

If you downgrade to Kotlin 1.9 then things 'should' work, there are example apps out there with such configuration, like the following one: https://github.com/realityexpander/KMP_Room/tree/main

yb...@google.com <yb...@google.com> #3Jul 30, 2020 08:35PM

Yes this does seem like a KSP issue however it only starts happening when room is added to the project. As the template project compiles just fine.

Will try to use the example provided by you to check if it fixes the issue.

ah...@gmail.com <ah...@gmail.com> #4Jul 31, 2020 05:11PM

Note that this issue happens when applying the Compose, KSP and Room Plugin together in Kotlin 2.0.x, the workaround for now is to not use the Room Gradle Plugin and instead specify the schema location vis KSP arguments:

// In the build.gradle
ksp {
    arg("room.schemaLocation", "${projectDir}/schemas")
}

yb...@google.com <yb...@google.com> #5Jul 31, 2020 08:14PM

Hi, I encountered a similar problem and was able to resolve it by updating the dependencies

room = "2.7.0-alpha08"
ksp = "2.0.20-1.0.25"

compose-plugin = "1.6.11"
kotlin = "2.0.20"

ah...@gmail.com <ah...@gmail.com> #6Jul 31, 2020 08:46PM

https://github.com/androidx/androidx/pull/49

ap...@google.com <ap...@google.com> #7Aug 5, 2020 04:07AM

Marked as fixed.

Project: platform/frameworks/support
Branch: androidx-master-dev

commit 3e6792c7521cdf41c295a1c0037137ecf9c7a005
Author: Ahmed El-Helw <ahmedre@gmail.com>
Date: Wed Aug 05 00:03:57 2020

[GH] Support opening gzipped databases.

This patch adds a method for creating a database from a gzipped file.
This is only implemented for external files, since assets are
transparently gzipped and extracted by the build tools.

Test: Added a unit test to SQLiteCopyOpenHelperTest.
Fixes:

b/146911060

This is an imported pull request from

https://github.com/androidx/androidx/pull/49.

Resolves #49
Github-Pr-Head-Sha: 568196d7b1800e9055de0dae7f509008cbc64c71
GitOrigin-RevId: 5de26bc6b6107d6aa2079f53d303e1216879ffa9
Change-Id: Ibd6b85f03748062a1ced22daf250944d5f07ef5b

M room/integration-tests/testapp/src/androidTest/java/androidx/room/integration/testapp/test/PrepackageTest.java
A room/integration-tests/testapp/src/main/assets/databases/products_v1.db.zip
M room/runtime/api/current.txt
M room/runtime/api/public_plus_experimental_current.txt
M room/runtime/api/restricted_current.txt
M room/runtime/src/main/java/androidx/room/RoomDatabase.java
M room/runtime/src/main/java/androidx/room/SQLiteCopyOpenHelper.java
M room/runtime/src/main/java/androidx/room/SQLiteCopyOpenHelperFactory.java
M room/runtime/src/test/java/androidx/room/BuilderTest.java
M room/runtime/src/test/java/androidx/room/SQLiteCopyOpenHelperTest.kt

https://android-review.googlesource.com/1388184

ap...@google.com <ap...@google.com> #8Aug 5, 2020 04:07AM

Project: platform/frameworks/support
Branch: androidx-master-dev

commit 1263185ef8c50d4059758e382610345a24f82c53
Author: Daniel Santiago Rivera <danysantiago@google.com>
Date: Fri Jul 31 19:28:39 2020

Minor changes and API files update for aosp/1384212

Additionally add new copyFromInputStream property to
DatabaseConfiguration for consistency.

Fixes:

b/146911060

Relnote: N/A
Test: ./gradlew bOS
Change-Id: I6fca34150c96a7039211ee3db46cf9a714667a9c

M room/integration-tests/testapp/src/androidTest/java/androidx/room/integration/testapp/test/PrepackageTest.java
M room/runtime/api/current.txt
M room/runtime/api/public_plus_experimental_current.txt
M room/runtime/api/restricted_current.txt
M room/runtime/src/main/java/androidx/room/DatabaseConfiguration.java
M room/runtime/src/main/java/androidx/room/RoomDatabase.java
M room/runtime/src/main/java/androidx/room/SQLiteCopyOpenHelper.java
M room/runtime/src/main/java/androidx/room/SQLiteCopyOpenHelperFactory.java
M room/testing/src/main/java/androidx/room/testing/MigrationTestHelper.java

https://android-review.googlesource.com/1384013