Switch to using JS-IR compiler only. Rename door-annotations to room-…

…annotations to make it clear what the module provides.
UstadMobile · Mar 28, 2023 · 516cc69 · 516cc69
1 parent 7741357
commit 516cc69
Show file tree

Hide file tree

Showing 29 changed files with 45 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -71,7 +71,7 @@ kotlin {
             dependencies {
                 //Add Door itself
                 implementation "com.github.UstadMobile.door:door-runtime:$version_door"
-                compileOnly "com.github.UstadMobile.door:door-annotations:$version_door"
+                implementation "com.github.UstadMobile.door:room-annotations:$version_door"
             }
         }
         
@@ -96,6 +96,15 @@ dependencies {
 }
 ```
 
+On your Android application module (e.g. the one building the APK), you must exclude room-annotations to avoid a
+duplicate class error. This is required due to a Kotlin/JS bug as per this [README](room-annotations/).
+
+```
+configurations.all {
+    exclude group: "com.github.UstadMobile.door", module: "room-annotations"
+}
+```
+
 2. Now create your database, DAOs, and entities in Kotlin multiplatform common code:
 
 Database:
@@ -314,7 +323,7 @@ Option 2: Use comment hacks:
 
 * [app-testdb](app-testdb/) Contains a test React/JS app. Used to run manual tests that don't seem to work in automated
 JS tests.
-* [door-annotations](door-annotations/) Contains androidx annotations identical to those used in room,
+* [room-annotations](room-annotations/) Contains androidx annotations identical to those used in room,
 used to compile on non-Android targets.
 * [door-compiler](door-compiler/) Contains the actual annotation processor based on Kotlin Poet
 * [door-runtime](door-runtime/) The main runtime module - contains classes and functions used by generated

diff --git a/app-testdb/build.gradle b/app-testdb/build.gradle
@@ -11,7 +11,7 @@ repositories {
 }
 
 kotlin {
-    js(LEGACY) {
+    js(IR) {
         binaries.executable()
         browser {
             commonWebpackConfig {

diff --git a/build.gradle b/build.gradle
@@ -27,7 +27,7 @@ plugins {
 
 
 group 'com.github.UstadMobile.door'
-version '0.0.63o7'
+version '0.0.63o10'
 
 ext.localProperties = new Properties()
 

diff --git a/door-compiler/build.gradle b/door-compiler/build.gradle
@@ -31,7 +31,7 @@ compileTestKotlin {
 
 dependencies {
     implementation project(":door-runtime")
-    implementation project(":door-annotations")
+    implementation project(':room-annotations')
     implementation "org.jetbrains.kotlin:kotlin-stdlib"
     implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:$version_kotlinx_serialization"
     implementation "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"

diff --git a/door-runtime/build.gradle b/door-runtime/build.gradle
@@ -49,7 +49,7 @@ kotlin {
         }
     }
 
-    js(BOTH) {
+    js(IR) {
         browser {
             testTask {
                 useKarma {
@@ -68,7 +68,7 @@ kotlin {
     sourceSets {
         commonMain {
             dependencies {
-                compileOnly project(":door-annotations")
+                implementation project(":room-annotations")
                 implementation kotlin("stdlib-common")
                 implementation "io.ktor:ktor-client-core:$version_ktor"
                 implementation "io.ktor:ktor-client-json:$version_ktor"
@@ -100,6 +100,7 @@ kotlin {
         androidMain {
             dependsOn commonJvmMain
             dependencies {
+                implementation project(":room-annotations")
                 implementation "androidx.room:room-runtime:$version_android_room"
                 implementation "androidx.room:room-ktx:$version_android_room"
                 implementation "androidx.lifecycle:lifecycle-livedata-ktx:$version_androidx_lifecycle"

diff --git a/door-testdb/build.gradle b/door-testdb/build.gradle
@@ -53,7 +53,7 @@ kotlin {
         }
     }
 
-    js(LEGACY) {
+    js(IR) {
         browser {
             testTask {
                 useKarma {
@@ -69,7 +69,7 @@ kotlin {
             dependencies {
                 implementation kotlin('stdlib-common')
                 implementation project(":door-runtime")
-                compileOnly project(":door-annotations")
+                implementation project(":room-annotations")
 
                 implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:$version_kotlinx_serialization"
                 implementation "io.ktor:ktor-client-content-negotiation:$version_ktor"

diff --git a/kotlin-js-store/yarn.lock b/kotlin-js-store/yarn.lock
@@ -2853,6 +2853,11 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.9.5.tgz#586f0dba300cde8be52dd1ac4f7e1009c1b13f36"
   integrity sha512-hSAifV3k+i6lEoCJ2k6R2Z/rp/H3+8sdmcn5NrS3/3kE7+RyZXm9aqvxWqjEXHAd8b0pShatpcdMTvEdvAJltQ==
 
+[email protected]:
+  version "4.7.4"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.7.4.tgz#1a88596d1cf47d59507a1bcdfb5b9dfe4d488235"
+  integrity sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==
+
 ua-parser-js@^0.7.30:
   version "0.7.31"
   resolved "https://registry.yarnpkg.com/ua-parser-js/-/ua-parser-js-0.7.31.tgz#649a656b191dffab4f21d5e053e27ca17cbff5c6"

diff --git a/room-annotations/README.md b/room-annotations/README.md
@@ -0,0 +1,11 @@
+# room-annotations
+
+This module provides a copy of Room annotations so that they can be used on multiplatform code. 
+
+It must be excluded from any Android app build to avoid a duplicate class error. Normally it would be used as a compileOnly 
+dependency, however [Kotlin bug KT-43500](https://youtrack.jetbrains.com/issue/KT-43500) means that any consumer using 
+the JS-IR compiler will not compile.
+
+Using expect/actual on annotation won't work because 1) Room's symbol processor won't recognize the link and 2) using
+a typealias prevents multiplatform code from using default parameters.
+
diff --git a/door-annotations/build.gradle → room-annotations/build.gradle b/door-annotations/build.gradle → room-annotations/build.gradle
@@ -36,7 +36,7 @@ android {
             consumerProguardFiles 'proguard-rules.pro'
         }
     }
-    namespace 'com.ustadmobile.door.annotations'
+    namespace 'com.ustadmobile.door.roomannotations'
 }
 
 kotlin {
@@ -54,7 +54,7 @@ kotlin {
         }
     }
 
-    js(BOTH) {
+    js(IR) {
         browser()
     }
 

diff --git a/...Main/kotlin/androidx/annotation/IntDef.kt → ...Main/kotlin/androidx/annotation/IntDef.kt b/...Main/kotlin/androidx/annotation/IntDef.kt → ...Main/kotlin/androidx/annotation/IntDef.kt
diff --git a/...in/kotlin/androidx/annotation/IntRange.kt → ...in/kotlin/androidx/annotation/IntRange.kt b/...in/kotlin/androidx/annotation/IntRange.kt → ...in/kotlin/androidx/annotation/IntRange.kt
diff --git a/...ain/kotlin/androidx/annotation/NonNull.kt → ...ain/kotlin/androidx/annotation/NonNull.kt b/...ain/kotlin/androidx/annotation/NonNull.kt → ...ain/kotlin/androidx/annotation/NonNull.kt
diff --git a/...kotlin/androidx/annotation/RequiresApi.kt → ...kotlin/androidx/annotation/RequiresApi.kt b/...kotlin/androidx/annotation/RequiresApi.kt → ...kotlin/androidx/annotation/RequiresApi.kt
diff --git a/...onMain/kotlin/androidx/room/ColumnInfo.kt → ...onMain/kotlin/androidx/room/ColumnInfo.kt b/...onMain/kotlin/androidx/room/ColumnInfo.kt → ...onMain/kotlin/androidx/room/ColumnInfo.kt
diff --git a/...commonMain/kotlin/androidx/room/Delete.kt → ...commonMain/kotlin/androidx/room/Delete.kt b/...commonMain/kotlin/androidx/room/Delete.kt → ...commonMain/kotlin/androidx/room/Delete.kt
diff --git a/...mmonMain/kotlin/androidx/room/Embedded.kt → ...mmonMain/kotlin/androidx/room/Embedded.kt b/...mmonMain/kotlin/androidx/room/Embedded.kt → ...mmonMain/kotlin/androidx/room/Embedded.kt
diff --git a/...commonMain/kotlin/androidx/room/Entity.kt → ...commonMain/kotlin/androidx/room/Entity.kt b/...commonMain/kotlin/androidx/room/Entity.kt → ...commonMain/kotlin/androidx/room/Entity.kt
diff --git a/...onMain/kotlin/androidx/room/ForeignKey.kt → ...onMain/kotlin/androidx/room/ForeignKey.kt b/...onMain/kotlin/androidx/room/ForeignKey.kt → ...onMain/kotlin/androidx/room/ForeignKey.kt
diff --git a/...commonMain/kotlin/androidx/room/Ignore.kt → ...commonMain/kotlin/androidx/room/Ignore.kt b/...commonMain/kotlin/androidx/room/Ignore.kt → ...commonMain/kotlin/androidx/room/Ignore.kt
diff --git a/.../commonMain/kotlin/androidx/room/Index.kt → .../commonMain/kotlin/androidx/room/Index.kt b/.../commonMain/kotlin/androidx/room/Index.kt → .../commonMain/kotlin/androidx/room/Index.kt
diff --git a/...commonMain/kotlin/androidx/room/Insert.kt → ...commonMain/kotlin/androidx/room/Insert.kt b/...commonMain/kotlin/androidx/room/Insert.kt → ...commonMain/kotlin/androidx/room/Insert.kt
diff --git a/...otlin/androidx/room/OnConflictStrategy.kt → ...otlin/androidx/room/OnConflictStrategy.kt b/...otlin/androidx/room/OnConflictStrategy.kt → ...otlin/androidx/room/OnConflictStrategy.kt
diff --git a/...onMain/kotlin/androidx/room/PrimaryKey.kt → ...onMain/kotlin/androidx/room/PrimaryKey.kt b/...onMain/kotlin/androidx/room/PrimaryKey.kt → ...onMain/kotlin/androidx/room/PrimaryKey.kt
diff --git a/.../commonMain/kotlin/androidx/room/Query.kt → .../commonMain/kotlin/androidx/room/Query.kt b/.../commonMain/kotlin/androidx/room/Query.kt → .../commonMain/kotlin/androidx/room/Query.kt
diff --git a/...mmonMain/kotlin/androidx/room/RawQuery.kt → ...mmonMain/kotlin/androidx/room/RawQuery.kt b/...mmonMain/kotlin/androidx/room/RawQuery.kt → ...mmonMain/kotlin/androidx/room/RawQuery.kt
diff --git a/...nMain/kotlin/androidx/room/Transaction.kt → ...nMain/kotlin/androidx/room/Transaction.kt b/...nMain/kotlin/androidx/room/Transaction.kt → ...nMain/kotlin/androidx/room/Transaction.kt
diff --git a/...commonMain/kotlin/androidx/room/Update.kt → ...commonMain/kotlin/androidx/room/Update.kt b/...commonMain/kotlin/androidx/room/Update.kt → ...commonMain/kotlin/androidx/room/Update.kt
diff --git a/settings.gradle b/settings.gradle
@@ -13,6 +13,6 @@ include 'door-testdb'
 include 'app-testdb'
 include ':test-app-android'
 include 'door-testdb-server'
-include 'door-annotations'
+include 'room-annotations'
 include 'door-shallowcopy'
 
diff --git a/test-app-android/build.gradle b/test-app-android/build.gradle
@@ -45,6 +45,13 @@ android {
     namespace 'com.ustadmobile.door.testandroid'
 }
 
+/*
+ * Excluded as per README for the room-annotations module.
+ */
+configurations.all {
+    exclude module: "room-annotations"
+}
+
 dependencies {
     implementation project(":door-runtime")
     implementation project(":door-testdb")