Generated ViewModel declaration in module differs between Android and iOS in Compose Multiplatform app

[krzdabrowski]

Describe the bug
I have a fully KMP & CMP app where my abstract class BaseViewModel reside in :core module, in commonMain, and multiple feature modules are implementing it, for example class LoginViewModel(...) : BaseViewModel() (in commonMains too). All ViewModels are wrapped with @KoinViewModel.

I noticed that in build/generated classes, the modules' code differ between platforms, causing serious issue - I'm not able to build the iOS app. See details below.

To Reproduce

In ksp/android, my example LoginModule looks like this:

public val package_LoginModule : Module get() = module {
	viewModel() { _ -> package.LoginViewModel(...) } 
}
public val package.LoginModule.module : org.koin.core.module.Module get() = package_LoginModule

However, in ksp/iosArm64, LoginViewModel is explicitly binded with its parent:

public val package_LoginModule : Module get() = module {
	viewModel() { _ -> package.LoginViewModel(...) } bind(otherpackage.BaseViewModel::class)
}
public val package.LoginModule.module : org.koin.core.module.Module get() = package_LoginModule

This causes a big issue in KoinMeta generated file for iOS because such entry is added:

public fun _KSP_OtherPackageBaseViewModel() : Unit = Unit

As multiple ViewModels are implementing BaseViewModel in different Gradle feature modules, this entry exists in many generated files, with the same name for BaseViewModel.

In result, running :shared-ios-module:linkDebugFrameworkIosArm64 causes a duplication failure:

e: Compilation failed: IrSimpleFunctionSymbolImpl is already bound. Signature: org.koin.ksp.generated/_KSP_OtherPackageBaseViewModel|_KSP_OtherPackageBaseViewModel(){}[0]. Owner: FUN name:_KSP_OtherPackageBaseViewModel visibility:public modality:FINAL <> () returnType:<unbound IrClassSymbolImpl>

And finally, I'm not able to build the iOS version of the app 😞

Expected behavior
Generated modules (for ViewModels) should be the same no matter the target platform; in this case I believe there should be no binding for BaseViewModel like Android does - because Android app compiles and works fine.

Koin project used and used version:

• Koin 4.1.0-Beta8, can't get higher due to this bug
• Koin Annotations 2.0.0 or 2.0.1-RC1.
• other dependencies are the latest stable possible from JetBrains, like ViewModel KMP/CMP dependency

[krzdabrowski]

@arnaudgiuliani, I've created a minimal reproducible repository that reflects my app structure, while still throwing an error: https://github.com/krzdabrowski/cmp-koin-bug

• ./gradlew :umbrella-ios:compileKotlinIosArm64 will succeed but will also create public fun _KSP_EuKrzdabrowskiCmpkoinbugCoreBaseViewModel() : Unit = Unit in both basic-feature-a/build/generated/ksp/iosArm64/iosArm64Main and basic-feature-b/build/generated/ksp/iosArm64/iosArm64Main (which doesn't exist at all for android)
• ./gradlew :umbrella-ios:linkDebugFrameworkIosArm64 will fail with an error message e: Compilation failed: IrSimpleFunctionSymbolImpl is already bound. Signature: org.koin.ksp.generated/_KSP_EuKrzdabrowskiCmpkoinbugCoreBaseViewModel|_KSP_EuKrzdabrowskiCmpkoinbugCoreBaseViewModel(){}[0]

I hope this will be helpful 🙂

[arnaudgiuliani]

Ok, scheduling it for 2.1.1 👍

[arnaudgiuliani]

@krzdabrowski can you check with Koin Annotations 2.1.0 ?

[krzdabrowski]

@arnaudgiuliani, unfortunately the error still persists using Koin 4.1.0 and Koin Annotations 2.1.0

[krzdabrowski]

FYI: removing every instance of @ComponentScan annotation and @Single/@Factory annotations over classes/interfaces in the project, then migrating into Dagger-like style of defining dependencies (modules with provider functions inside for everything) fixes the issue - probably because this way I can have full control what and how I bind my dependencies.

This is unfortunately not the first issue with the new @ComponentScan behavior after 2.0.0 release, where before things were working and now are broken 🙁

[arnaudgiuliani]

Let me check 👍

[SubhrajyotiSen]

I too am on Koin 4.1.0 and Koin Annotations 2.1.0, and facing the issue with a similar ViewModel base class

[arnaudgiuliani]

Yes, after a few tests, sounds like it's on ViewModel. I'm on it 👍

[arnaudgiuliani]

Found the issue. Fix in #296

Will deploy it in the next 2.1.1 release