Merge pull request #197 from Jeffset/thread-asserter-fix

[api] Re-implement thread assertions as an option instead of global state.

Author: bacecek

api/dynamic/src/main/kotlin/com/yandex/yatagan/dynamic/ReflectionLoader.kt

@@ -34,6 +34,7 @@ private const val MAX_ISSUE_ENCOUNTER_PATHS_PROPERTY = "maxIssueEncounterPaths"
 private const val IS_STRICT_MODE_PROPERTY = "enableStrictMode"
 private const val USE_PLAIN_OUTPUT_PROPERTY = "usePlainOutput"
 private const val DAGGER_COMPATIBILITY = "enableDaggerCompatibility"
+private const val THREAD_CHECKER_CLASS_NAME = "threadCheckerClassName"
 
 /**
  * Instantiated reflectively.
@@ -91,6 +92,9 @@ internal class ReflectionLoader : ImplementationLoader by ReflectionLoader {
                             params.enableDaggerCompatibility = value.toString().toBooleanStrictOrNull()
                                 ?: throw IllegalStateException("Expected boolean for `$property`, got `$value`")
                         }
+                        THREAD_CHECKER_CLASS_NAME -> {
+                            params.threadCheckerClassName = value?.toString()
+                        }
                         else -> {
                             throw IllegalStateException("Unknown property `$property`")
                         }

api/public/api/public.api

@@ -176,7 +176,6 @@ public final class com/yandex/yatagan/Yatagan {
 	public static final fun autoBuilder (Ljava/lang/Class;)Lcom/yandex/yatagan/AutoBuilder;
 	public static final fun builder (Ljava/lang/Class;)Ljava/lang/Object;
 	public static final fun create (Ljava/lang/Class;)Ljava/lang/Object;
-	public static final fun getThreadAsserter ()Lcom/yandex/yatagan/ThreadAsserter;
 	public static final fun setThreadAsserter (Lcom/yandex/yatagan/ThreadAsserter;)V
 }
 

api/public/src/main/kotlin/com/yandex/yatagan/Yatagan.kt

@@ -47,12 +47,15 @@ public object Yatagan {
         null
     }
 
-    /**
-     * [ThreadAsserter] object to be used in Single Thread component implementations.
-     */
-    @Volatile
     @JvmStatic
-    public var threadAsserter: ThreadAsserter? = null
+    @Deprecated(
+        "Use `yatagan.threadCheckerClassName` option instead.",
+        level = DeprecationLevel.ERROR,
+    )
+    @Suppress("UNUSED_PARAMETER")
+    public fun setThreadAsserter(threadAsserter: ThreadAsserter?) {
+        // NOP
+    }
 
     /**
      * Use this to create a component builder instance for root components that declare it.

api/public/src/main/kotlin/com/yandex/yatagan/internal/ThreadAssertions.kt

@@ -16,13 +16,14 @@
 
 package com.yandex.yatagan.internal
 
-import com.yandex.yatagan.Yatagan
-
+@Deprecated(
+    message = "May be used by components generated with earlier versions of the framework",
+    level = DeprecationLevel.HIDDEN,
+)
 @YataganInternal
 public object ThreadAssertions {
     @JvmStatic
     public fun assertThreadAccess() {
-        // TODO(#44): Remove this and use `Yatagan.threadAsserter` directly.
-        Yatagan.threadAsserter?.assertThreadAccess()
+        // No-op
     }
 }

codegen/impl/src/main/kotlin/com/yandex/yatagan/codegen/impl/ComponentGenerator.kt

@@ -24,6 +24,7 @@ import com.yandex.yatagan.codegen.poetry.TypeSpecBuilder
 import com.yandex.yatagan.codegen.poetry.buildClass
 import com.yandex.yatagan.codegen.poetry.buildExpression
 import com.yandex.yatagan.core.graph.BindingGraph
+import com.yandex.yatagan.core.graph.ThreadChecker
 import com.yandex.yatagan.core.graph.component1
 import com.yandex.yatagan.core.graph.component2
 import com.yandex.yatagan.lang.Field
@@ -39,6 +40,7 @@ import javax.lang.model.element.Modifier.STATIC
 @Singleton
 internal class ComponentGenerator @Inject constructor(
     component: GeneratorComponent,
+    threadChecker: ThreadChecker,
     private val options: Options,
     private val graph: BindingGraph,
     private val contributors: List<Contributor>,
@@ -51,7 +53,6 @@ internal class ComponentGenerator @Inject constructor(
     data class Options(
         val maxSlotsPerSwitch: Int,
         val enableProvisionNullChecks: Boolean,
-        val enableThreadChecks: Boolean,
         val sortMethodsForTesting: Boolean,
         val generatedAnnotationClassName: ClassName?,
         val enableDaggerCompatMode: Boolean,
@@ -65,6 +66,7 @@ internal class ComponentGenerator @Inject constructor(
         Yatagan.builder(GeneratorComponent.Factory::class.java).create(
             graph = childGraph,
             options = options,
+            threadChecker = threadChecker,
         ).generator
     }
 

codegen/impl/src/main/kotlin/com/yandex/yatagan/codegen/impl/ComponentGeneratorFacade.kt

@@ -21,15 +21,16 @@ import com.squareup.javapoet.JavaFile
 import com.squareup.javapoet.TypeSpec
 import com.yandex.yatagan.Yatagan
 import com.yandex.yatagan.core.graph.BindingGraph
+import com.yandex.yatagan.core.graph.ThreadChecker
 import com.yandex.yatagan.lang.langFactory
 
 class ComponentGeneratorFacade(
     graph: BindingGraph,
     maxSlotsPerSwitch: Int,
-    enableThreadChecks: Boolean,
     enableProvisionNullChecks: Boolean,
     sortMethodsForTesting: Boolean,
     enableDaggerCompatMode: Boolean,
+    threadChecker: ThreadChecker,
 ) {
     interface GeneratedFile {
         val targetPackageName: String
@@ -43,11 +44,11 @@ class ComponentGeneratorFacade(
         options = ComponentGenerator.Options(
             maxSlotsPerSwitch = maxSlotsPerSwitch,
             enableProvisionNullChecks = enableProvisionNullChecks,
-            enableThreadChecks = enableThreadChecks,
             sortMethodsForTesting = sortMethodsForTesting,
             generatedAnnotationClassName = generatedAnnotationClassName(),
             enableDaggerCompatMode = enableDaggerCompatMode,
         ),
+        threadChecker = threadChecker,
     )
 
     fun generate(): List<GeneratedFile> = buildList {

codegen/impl/src/main/kotlin/com/yandex/yatagan/codegen/impl/GeneratorComponent.kt

@@ -12,6 +12,7 @@ import com.yandex.yatagan.Optional
 import com.yandex.yatagan.Provides
 import com.yandex.yatagan.base.api.Extensible
 import com.yandex.yatagan.core.graph.BindingGraph
+import com.yandex.yatagan.core.graph.ThreadChecker
 import javax.inject.Qualifier
 import javax.inject.Singleton
 
@@ -61,6 +62,7 @@ internal interface GeneratorComponent {
         fun create(
             @BindsInstance graph: BindingGraph,
             @BindsInstance options: ComponentGenerator.Options,
+            @BindsInstance threadChecker: ThreadChecker,
         ): GeneratorComponent
     }
 

codegen/impl/src/main/kotlin/com/yandex/yatagan/codegen/impl/Names.kt

@@ -24,9 +24,8 @@ internal object Names {
     val Provider: ClassName = ClassName.get("javax.inject", "Provider")
     val Optional: ClassName = ClassName.get("com.yandex.yatagan", "Optional")
     val AutoBuilder: ClassName = ClassName.get("com.yandex.yatagan", "AutoBuilder")
-    val ThreadAssertions: ClassName = ClassName.get("com.yandex.yatagan.internal", "ThreadAssertions")
     val Checks: ClassName = ClassName.get("com.yandex.yatagan.internal", "Checks")
-    val YataganGenerated = ClassName.get("com.yandex.yatagan.internal", "YataganGenerated")
+    val YataganGenerated: ClassName = ClassName.get("com.yandex.yatagan.internal", "YataganGenerated")
 
     val AssertionError: ClassName = ClassName.get(java.lang.AssertionError::class.java)
     val Class: ClassName = ClassName.get(java.lang.Class::class.java)

codegen/impl/src/main/kotlin/com/yandex/yatagan/codegen/impl/ScopedProviderGenerator.kt

@@ -20,6 +20,7 @@ import com.squareup.javapoet.ClassName
 import com.yandex.yatagan.codegen.poetry.TypeSpecBuilder
 import com.yandex.yatagan.codegen.poetry.buildClass
 import com.yandex.yatagan.core.graph.BindingGraph
+import com.yandex.yatagan.core.graph.ThreadChecker
 import javax.inject.Inject
 import javax.inject.Singleton
 import javax.lang.model.element.Modifier.FINAL
@@ -32,6 +33,7 @@ import javax.lang.model.element.Modifier.VOLATILE
 internal class ScopedProviderGenerator @Inject constructor(
     private val componentImplName: ClassName,
     private val options: ComponentGenerator.Options,
+    private val threadChecker: ThreadChecker,
     graph: BindingGraph,
 ) : ComponentGenerator.Contributor {
     private var isUsed = false
@@ -79,9 +81,7 @@ internal class ScopedProviderGenerator @Inject constructor(
                                 }
                             }
                         } else {
-                            if (options.enableThreadChecks) {
-                                +"%T.assertThreadAccess()".formatCode(Names.ThreadAssertions)
-                            }
+                            threadChecker.generateThreadAssertion(this)
                             +"local = mDelegate.%N(mIndex)".formatCode(SlotSwitchingGenerator.FactoryMethodName)
                             +"mValue = local"
                         }

codegen/impl/src/main/kotlin/com/yandex/yatagan/codegen/impl/accessStrategies.kt

@@ -23,6 +23,7 @@ import com.yandex.yatagan.codegen.poetry.ExpressionBuilder
 import com.yandex.yatagan.codegen.poetry.TypeSpecBuilder
 import com.yandex.yatagan.codegen.poetry.buildExpression
 import com.yandex.yatagan.core.graph.BindingGraph
+import com.yandex.yatagan.core.graph.ThreadChecker
 import com.yandex.yatagan.core.graph.bindings.Binding
 import com.yandex.yatagan.core.model.ConditionScope
 import com.yandex.yatagan.core.model.DependencyKind
@@ -70,7 +71,7 @@ internal class CachingStrategySingleThread @AssistedInject constructor(
     @Assisted binding: Binding,
     @FieldsNamespace fieldsNs: Namespace,
     @MethodsNamespace methodsNs: Namespace,
-    private val options: ComponentGenerator.Options,
+    private val threadChecker: ThreadChecker,
 ) : CachingStrategyBase(binding, fieldsNs, methodsNs) {
     override fun generateInComponent(builder: TypeSpecBuilder) = with(builder) {
         val targetType = binding.target.typeName()
@@ -82,9 +83,7 @@ internal class CachingStrategySingleThread @AssistedInject constructor(
             returnType(targetType)
             +"%T local = this.%N".formatCode(ClassName.OBJECT, instanceFieldName)
             controlFlow("if (local == null)") {
-                if (options.enableThreadChecks) {
-                    +"%T.assertThreadAccess()".formatCode(Names.ThreadAssertions)
-                }
+                threadChecker.generateThreadAssertion(this)
                 +buildExpression {
                     +"local = "
                     binding.generateCreation(builder = this, inside = binding.owner, isInsideInnerClass = false)