Objectbox entities in shared library module

[gmkado]

Issue Basics

• ObjectBox version: 1.2.0-RC
• Reproducibility: always

Reproducing the bug

Description

I have a project set up with the following modules:
-mobile (application)
-shared (library)
-wear (application)

I have a single entity taken directly from the kotlin example "Note.kt" Originally I placed this in the shared module so that I could use the same entities in the mobile and wear application, but after building the project it complains -> "Unresolved reference: MyObjectBox"

When I moved Note.kt into the mobile app and build, it recognizes MyObjectBox fine.

Code

build.gradle (mobile)

apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-kapt'
apply plugin: 'io.objectbox'
apply plugin: 'kotlin-android-extensions

android {
    compileSdkVersion 27
    buildToolsVersion "26.0.2"
    defaultConfig {
        applicationId "com.example.grant.gradechaser"
        minSdkVersion 23
        targetSdkVersion 27
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
        exclude group: 'com.android.support', module: 'support-annotations'
    })
    wearApp project(':wear')
    compile "com.android.support:appcompat-v7:$rootProject.ext.supportVersion"
    compile "com.android.support:support-v4:$rootProject.ext.supportVersion"

    compile "com.android.support:design:$rootProject.ext.supportVersion"
    compile 'com.android.support.constraint:constraint-layout:1.0.2'
    testCompile 'junit:junit:4.12'

    compile "org.jetbrains.kotlin:kotlin-stdlib-jre7:$kotlin_version"

}

repositories {
    mavenCentral()
}

build.gradle (shared)

apply plugin: 'com.android.library'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-kapt'
apply plugin: 'io.objectbox'


// Until the ObjectBox Gradle plugin has better support for Kotlin, we must help it a bit:
//task('compileKotlin').dependsOn objectbox
android.sourceSets.main.java.srcDirs += 'build/generated/source/objectbox'

android {
    compileSdkVersion 27

    defaultConfig {
        minSdkVersion 23
        targetSdkVersion 27
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"

    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
    sourceSets {
        main.java.srcDirs += 'src/main/kotlin'
    }

}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])

    implementation "com.android.support:appcompat-v7:$rootProject.ext.supportVersion"
    testImplementation 'junit:junit:4.12'
    androidTestImplementation 'com.android.support.test:runner:1.0.1'
    androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.1'
    compile "org.jetbrains.kotlin:kotlin-stdlib-jre7:$kotlin_version"

    compile "io.objectbox:objectbox-android:$objectboxVersion"
    compile "io.objectbox:objectbox-kotlin:$objectboxVersion" // some useful Kotlin extension functions
    kapt "io.objectbox:objectbox-processor:$objectboxVersion" // When using Kotlin use kapt instead:
}
repositories {
    mavenCentral()
}

The wear build.gradle looks pretty similar to the mobile one, so I didn't include it.
I've tried putting the lines that add the generated code to the sourceSet in the mobile module too but that didn't fix the problem.

Is this module setup not supported?
I saw that you mentioned here

As a rule of thumb, they should reside in a single module. You could have multiple modules with entities, but only if they are totally separated (also different DB file).

But if they are all in the shared module, should that still work?

[greenrobot]

As long as you have all entities in one place (module), it should work. We have an internal test for this scenarios. So.. let's focus on the library module. After building the library, what to you see inside your-library/build/generated/source/kapt?

Minor: you should add apply plugin: 'io.objectbox' only to the module having the entities.

[gmkado]

Thanks for the help! If I take apply plugin: 'io.objectbox out of my app gradle then it doesn't recognize BoxStore in my App.kt. I added it back in to get the project to build.

It does look like the appropriate files are being generated. After I build, I go to shared\build\generated\source\kapt\debug\com\example\shared\model and find the following files:
MyObjectBox.java
Note_.java
NoteCursor.java

But my app module App.kt still doesn't recognize MyObjectBox.

[greenrobot]

I assume you have the import to com.example.shared.model.MyObjectBox?

Do all modules have the same build config (e.g. debug)?

I think this line does not do any good:

android.sourceSets.main.java.srcDirs += 'build/generated/source/objectbox'

[gmkado]

Ha, I'm an idiot. Forgot to add the dependency on the shared module. Added compile project(':shared') to my app module and it imports fine.

[tomeq93]

@greenrobot-team
Is multi-module support considered in near future? Option with boxstore per module does not sound well, and we cannot afford for keeping models in same module.
Great project btw :)

[greenrobot]

@tomeq93 Maybe a data model module is an option containing all the entities? Often it makes sense to have a vertical data model along a horizontal layer architecture.

[tomeq93]

@greenrobot-team Unfortunately it is not possible for our usecases. If somehow objectbox could generate code not only for entities inside same module but with dependent modules also, that would solve issue. Probably that is much more complicated that it sounds ^^

[greenrobot]

@tomeq93 Yes, rather complicated... ;-)

[aarajput]

Add this line. It will solve your problem.
apply plugin: 'kotlin-kapt'