Fix backward binary compatibility with Koin 3.4

Fixes gh-1829
InsertKoinIO · Mar 25, 2024 · 4deb6f6 · 4deb6f6
1 parent 0dcf904
commit 4deb6f6
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 3 deletions.
diff --git a/projects/core/koin-core/src/commonMain/kotlin/org/koin/dsl/KoinApplication.kt b/projects/core/koin-core/src/commonMain/kotlin/org/koin/dsl/KoinApplication.kt
@@ -24,15 +24,39 @@ typealias KoinAppDeclaration = KoinApplication.() -> Unit
  * Create a KoinApplication instance and help configure it
  * @author Arnaud Giuliani
  *
- * @param createEagerInstances - allow to create eager instances or not
- * @param appDeclaration
+ * @param createEagerInstances allow to create eager instances or not
+ * @param appDeclaration closure for configuration of a new Koin context
  */
 @KoinApplicationDslMarker
-fun koinApplication(createEagerInstances : Boolean = true, appDeclaration: KoinAppDeclaration? = null): KoinApplication {
+fun koinApplication(createEagerInstances: Boolean = true, appDeclaration: KoinAppDeclaration? = null): KoinApplication {
     val koinApplication = KoinApplication.init()
     appDeclaration?.invoke(koinApplication)
     if (createEagerInstances) {
         koinApplication.createEagerInstances()
     }
     return koinApplication
 }
+
+/**
+ * Create a KoinApplication instance and help configure it.
+ * This overload helps ensure backward-compatible bytecode.
+ *
+ * @param appDeclaration closure for configuration of a new Koin context
+ * @author Gary Spreder
+ */
+@KoinApplicationDslMarker
+fun koinApplication(appDeclaration: KoinAppDeclaration?): KoinApplication {
+    return koinApplication(createEagerInstances = true, appDeclaration = appDeclaration)
+}
+
+/**
+ * Create a KoinApplication instance and help configure it.
+ * This overload helps ensure backward-compatible bytecode.
+ *
+ * @param createEagerInstances allow to create eager instances or not
+ * @author Gary Spreder
+ */
+@KoinApplicationDslMarker
+fun koinApplication(createEagerInstances: Boolean): KoinApplication {
+    return koinApplication(createEagerInstances = createEagerInstances, appDeclaration = null)
+}
diff --git a/projects/core/koin-core/src/commonTest/kotlin/org/koin/dsl/KoinAppCreationTest.kt b/projects/core/koin-core/src/commonTest/kotlin/org/koin/dsl/KoinAppCreationTest.kt
@@ -30,6 +30,20 @@ class KoinAppCreationTest {
         assertHasNoStandaloneInstance()
     }
 
+    @Test
+    fun `maintain koinApplication source compatibility`() {
+        // Successful compilation and a lack of exceptions is sufficient
+        koinApplication { modules() }
+        koinApplication(createEagerInstances = true)
+        koinApplication(createEagerInstances = true) { modules() }
+        koinApplication(true) { modules() }
+        val declaration: KoinAppDeclaration = { modules() }
+        koinApplication(declaration)
+        koinApplication(createEagerInstances = true, declaration)
+        koinApplication(createEagerInstances = true, appDeclaration = declaration)
+        koinApplication(true, declaration)
+    }
+
     @Test
     fun `start a Koin application`() {
         val app = startKoin { }