[core] Properly detect and report dependency cycle, prevent StackOverflowError

Author: shchuko

projects/core/koin-core/src/commonMain/kotlin/org/koin/core/error/DependencyCycleException.kt

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2017-Present the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.koin.core.error
+
+class DependencyCycleException(msg: String) : Exception(msg)

projects/core/koin-core/src/commonMain/kotlin/org/koin/core/instance/ScopedInstanceFactory.kt

@@ -16,6 +16,7 @@
 package org.koin.core.instance
 
 import org.koin.core.definition.BeanDefinition
+import org.koin.core.error.DependencyCycleException
 import org.koin.core.scope.Scope
 import org.koin.core.scope.ScopeID
 import org.koin.mp.KoinPlatformTools
@@ -27,7 +28,8 @@ import org.koin.mp.KoinPlatformTools
 class ScopedInstanceFactory<T>(beanDefinition: BeanDefinition<T>) :
     InstanceFactory<T>(beanDefinition) {
 
-    private var values = hashMapOf<ScopeID, T>()
+    private var instanceCreationInProgressMap = KoinPlatformTools.safeHashMap<ScopeID, Unit>()
+    private var values = KoinPlatformTools.safeHashMap<ScopeID, T>()
 
     override fun isCreated(context: InstanceContext?): Boolean = (values[context?.scope?.id] != null)
 
@@ -38,12 +40,13 @@ class ScopedInstanceFactory<T>(beanDefinition: BeanDefinition<T>) :
         }
     }
 
-    override fun create(context: InstanceContext): T {
-        return if (values[context.scope.id] == null) {
-            super.create(context)
-        } else {
-            values[context.scope.id] ?: error("Scoped instance not found for ${context.scope.id} in $beanDefinition")
+    override fun create(context: InstanceContext): T = values.getOrPut(context.scope.id) {
+        if (instanceCreationInProgressMap.put(context.scope.id, Unit) != null) {
+            throw DependencyCycleException("Instance creation invoked twice, most likely it's a dependency cycle")
         }
+        val instance = super.create(context)
+        instanceCreationInProgressMap.remove(context.scope.id)
+        instance
     }
 
     override fun get(context: InstanceContext): T {

projects/core/koin-core/src/commonMain/kotlin/org/koin/core/instance/SingleInstanceFactory.kt

@@ -15,7 +15,9 @@
  */
 package org.koin.core.instance
 
+import co.touchlab.stately.concurrency.AtomicBoolean
 import org.koin.core.definition.BeanDefinition
+import org.koin.core.error.DependencyCycleException
 import org.koin.core.scope.Scope
 import org.koin.mp.KoinPlatformTools
 
@@ -26,6 +28,8 @@ import org.koin.mp.KoinPlatformTools
 class SingleInstanceFactory<T>(beanDefinition: BeanDefinition<T>) :
     InstanceFactory<T>(beanDefinition) {
 
+    private val instanceCreationInProgress = AtomicBoolean(false)
+
     private var value: T? = null
 
     private fun getValue(): T = value ?: error("Single instance created couldn't return value")
@@ -41,12 +45,13 @@ class SingleInstanceFactory<T>(beanDefinition: BeanDefinition<T>) :
         drop()
     }
 
-    override fun create(context: InstanceContext): T {
-        return if (value == null) {
-            super.create(context)
-        } else {
-            getValue()
+    override fun create(context: InstanceContext): T = value ?: run {
+        if (!instanceCreationInProgress.compareAndSet(false, true)) {
+            throw DependencyCycleException("Instance creation invoked twice, most likely it's a dependency cycle")
         }
+        val instance = super.create(context)
+        instanceCreationInProgress.value = false
+        instance
     }
 
     override fun get(context: InstanceContext): T {