Disable recompilation trigger functionality on Scala 3 completely due to bug scala/scala3#15976 (#1788)

* Revert parentheses

* Implement ForcedRecompilation token macro for Scala 3

* Disable recompilation trigger functionality on Scala 3 completely due to bug scala/scala3#15976

Author: neko-kai

distage/distage-extension-plugins/src/main/scala/distage/plugins/DistagePlugins.scala renamed to distage/distage-extension-plugins/src/main/scala-2/distage/plugins/DistagePlugins.scala

@@ -4,4 +4,4 @@ import izumi.distage.model.definition.BootstrapModuleDef
 import scala.annotation.unused
 
 /** @see [[izumi.distage.plugins.PluginDef]] */
-abstract class BootstrapPluginDef[T]()(implicit @unused recompilationToken: ForcedRecompilationToken[T]) extends BootstrapPlugin with BootstrapModuleDef
+abstract class BootstrapPluginDef[T](implicit @unused recompilationToken: ForcedRecompilationToken[T]) extends BootstrapPlugin with BootstrapModuleDef

distage/distage-extension-plugins/src/main/scala/distage/plugins/package.scala renamed to distage/distage-extension-plugins/src/main/scala-2/distage/plugins/package.scala

@@ -27,6 +27,10 @@ final abstract class ForcedRecompilationToken[T]
 object ForcedRecompilationToken {
   implicit def materialize[T]: ForcedRecompilationToken[T] = macro UniqueRecompilationTokenMacro.whiteboxMaterializeImpl
 
+  object disabled {
+    implicit def disable: ForcedRecompilationToken[Unit] = null
+  }
+
   object UniqueRecompilationTokenMacro {
     final val compilerLaunchId = java.util.UUID.randomUUID().toString
     var cachedTypedTree: Universe#Tree = null
@@ -68,10 +72,6 @@ object ForcedRecompilationToken {
     }
   }
 
-  object disabled {
-    implicit def disable: ForcedRecompilationToken[Unit] = null
-  }
-
   // an implementation for better days!
   // As of IDEA 2020.3 EAP, Intellij "Incrementality type: IDEA" doesn't regard changes in singleton types as "real",
   // so instead we have to use the trick above to encode the UUID as Eithers.

distage/distage-extension-plugins/src/main/scala/izumi/distage/plugins/BootstrapPluginDef.scala renamed to distage/distage-extension-plugins/src/main/scala-2/izumi/distage/plugins/BootstrapPluginDef.scala

@@ -24,4 +24,4 @@ import scala.annotation.unused
   * @see [[https://izumi.7mind.io/distage/distage-framework#plugins Plugins]]
   * @see [[https://izumi.7mind.io/distage/distage-framework#compile-time-checks Compile-time checks]]
   */
-abstract class PluginDef[T]()(implicit @unused recompilationToken: ForcedRecompilationToken[T]) extends PluginBase with ModuleDef
+abstract class PluginDef[T](implicit @unused recompilationToken: ForcedRecompilationToken[T]) extends PluginBase with ModuleDef

distage/distage-extension-plugins/src/main/scala-2/izumi/distage/plugins/ForcedRecompilationToken.scala

@@ -0,0 +1,5 @@
+package izumi.distage.plugins
+
+package object load {
+  private[load] type PluginDefType = PluginDef[?]
+}

distage/distage-extension-plugins/src/main/scala/izumi/distage/plugins/PluginDef.scala renamed to distage/distage-extension-plugins/src/main/scala-2/izumi/distage/plugins/PluginDef.scala

@@ -0,0 +1,29 @@
+package distage.plugins
+
+import izumi.distage.plugins
+import izumi.distage.plugins.{StaticPluginLoader, load}
+
+trait DistagePlugins {
+
+  type PluginBase = plugins.PluginBase
+  val PluginBase: plugins.PluginBase.type = plugins.PluginBase
+
+  type PluginDef = plugins.PluginDef
+
+  type BootstrapPlugin = plugins.BootstrapPlugin
+  val BootstrapPlugin: plugins.BootstrapPlugin.type = plugins.BootstrapPlugin
+
+  type BootstrapPluginDef = plugins.BootstrapPluginDef
+
+  type PluginLoader = load.PluginLoader
+  val PluginLoader: load.PluginLoader.type = load.PluginLoader
+
+  val StaticPlugingLoader: StaticPluginLoader.type = plugins.StaticPluginLoader
+
+  type PluginLoaderDefaultImpl = load.PluginLoaderDefaultImpl
+  val PluginLoaderDefaultImpl: load.PluginLoaderDefaultImpl.type = load.PluginLoaderDefaultImpl
+
+  type PluginConfig = plugins.PluginConfig
+  val PluginConfig: plugins.PluginConfig.type = plugins.PluginConfig
+
+}

distage/distage-extension-plugins/src/main/scala-2/izumi/distage/plugins/load/package.scala

@@ -0,0 +1,28 @@
+package distage
+
+import izumi.distage.plugins.load
+
+package object plugins extends DistagePlugins {
+
+  override type PluginBase = izumi.distage.plugins.PluginBase
+  override val PluginBase: izumi.distage.plugins.PluginBase.type = izumi.distage.plugins.PluginBase
+
+  override type PluginDef = izumi.distage.plugins.PluginDef
+
+  override type BootstrapPlugin = izumi.distage.plugins.BootstrapPlugin
+  override val BootstrapPlugin: izumi.distage.plugins.BootstrapPlugin.type = izumi.distage.plugins.BootstrapPlugin
+
+  override type BootstrapPluginDef = izumi.distage.plugins.BootstrapPluginDef
+
+  override type PluginLoader = load.PluginLoader
+  override val PluginLoader: load.PluginLoader.type = load.PluginLoader
+
+  override val StaticPlugingLoader: izumi.distage.plugins.StaticPluginLoader.type = izumi.distage.plugins.StaticPluginLoader
+
+  override type PluginLoaderDefaultImpl = load.PluginLoaderDefaultImpl
+  override val PluginLoaderDefaultImpl: load.PluginLoaderDefaultImpl.type = load.PluginLoaderDefaultImpl
+
+  override type PluginConfig = izumi.distage.plugins.PluginConfig
+  override val PluginConfig: izumi.distage.plugins.PluginConfig.type = izumi.distage.plugins.PluginConfig
+
+}

distage/distage-extension-plugins/src/main/scala-3/distage/plugins/DistagePlugins.scala

@@ -0,0 +1,7 @@
+package izumi.distage.plugins
+
+import izumi.distage.model.definition.BootstrapModuleDef
+import scala.annotation.unused
+
+/** @see [[izumi.distage.plugins.PluginDef]] */
+abstract class BootstrapPluginDef(implicit @unused recompilationToken: ForcedRecompilationToken[?]) extends BootstrapPlugin with BootstrapModuleDef

distage/distage-extension-plugins/src/main/scala-3/distage/plugins/package.scala

@@ -1,6 +1,7 @@
 package izumi.distage.plugins
 
 import scala.annotation.implicitNotFound
+import scala.quoted.{Expr, Quotes, Type}
 
 /**
   * This macro allows `distage`'s compile-time checks to cooperate with Scala's incremental compilation:
@@ -22,9 +23,25 @@ in which case you'll have to put a dummy implicit in scope, such as by using:
 final abstract class ForcedRecompilationToken[T]
 
 object ForcedRecompilationToken {
-  implicit def materialize[T]: ForcedRecompilationToken[T] = ???
+
+  transparent inline implicit def materialize[T]: ForcedRecompilationToken[T] = ${ UniqueRecompilationTokenMacro.materializeImpl }
 
   object disabled {
     implicit def disable: ForcedRecompilationToken[Unit] = null
   }
+
+  object UniqueRecompilationTokenMacro {
+    final val compilerLaunchId = java.util.UUID.randomUUID().toString
+
+    // TODO: research if caching typed trees optimization is possible and meaningful in Dotty
+    def materializeImpl[T](using quotes: Quotes): Expr[ForcedRecompilationToken[T]] = {
+      import quotes.reflect.*
+      val typeTree = ConstantType(StringConstant("abc"))
+      typeTree.asType.asInstanceOf[Type[T]] match {
+        case given Type[uuid] =>
+          '{ null.asInstanceOf[ForcedRecompilationToken[uuid]] }
+      }
+    }
+  }
+
 }

distage/distage-extension-plugins/src/main/scala-3/izumi/distage/plugins/BootstrapPluginDef.scala

@@ -1,6 +1,21 @@
 package izumi.distage.plugins
 
+import scala.compiletime.error
 
 trait PluginConfigStatic {
+  /** Scan the specified package *at compile-time* for classes and objects that inherit [[PluginBase]]
+    *
+    * WARN: may interact badly with incremental compilation
+    * WARN: will _not_ find plugins defined in the current module, only those defined in dependency modules
+    * (similarly to how you cannot call Scala macros defined in the current module)
+    */
+  inline def compileTime(pluginsPackage: String): PluginConfig = error("unimplemented")
 
+  /** Scan the the current source file's package *at compile-time* for classes and objects that inherit [[PluginBase]]
+    *
+    * WARN: may interact badly with incremental compilation
+    * WARN: will _not_ find plugins defined in the current module, only those defined in dependency modules
+    * (similarly to how you cannot call Scala macros defined in the current module)
+    */
+  inline def compileTimeThisPkg: PluginConfig = error("unimplemented")
 }

distage/distage-extension-plugins/src/main/scala-3/izumi/distage/plugins/ForcedRecompilationToken.scala

@@ -0,0 +1,27 @@
+package izumi.distage.plugins
+
+import izumi.distage.model.definition.ModuleDef
+import scala.annotation.unused
+
+/**
+  * Use it to define Plugins using [[izumi.distage.model.definition.dsl.ModuleDefDSL]] syntax
+  *
+  * {{{
+  *   object MyPlugin extends PluginDef {
+  *     include(myModule[F])
+  *
+  *     make[Xa[F]].from[Xa.Impl[F]]
+  *   }
+  * }}}
+  *
+  * @note Since this is an abstract class, you cannot mix it with other classes or use it as a mixin.
+  *       Instead, you may inherit from [[PluginBase]], which is a trait – but in that case compile-time checks will not
+  *       re-run when the class is updated in that case. Alternatively, you may use [[izumi.distage.model.definition.dsl.IncludesDSL#include]]
+  *       to compose modules as values instead of using inheritance.
+  *
+  * @param recompilationToken Makes compile-time checks re-run when the source code of this `PluginDef` is changed, if it's used in the checked role.
+  *
+  * @see [[https://izumi.7mind.io/distage/distage-framework#plugins Plugins]]
+  * @see [[https://izumi.7mind.io/distage/distage-framework#compile-time-checks Compile-time checks]]
+  */
+abstract class PluginDef(implicit @unused recompilationToken: ForcedRecompilationToken[?]) extends PluginBase with ModuleDef

distage/distage-extension-plugins/src/main/scala-3/izumi/distage/plugins/PluginConfigStatic.scala

@@ -1,5 +1,7 @@
 package izumi.distage.plugins
 
+import scala.compiletime.error
+
 /** Scan the specified package *at compile-time* for classes and objects that inherit [[PluginBase]]
   *
   * WARN: may interact badly with incremental compilation
@@ -10,4 +12,6 @@ package izumi.distage.plugins
   */
 object StaticPluginLoader {
 
+  inline def scanCompileTime(pluginsPackage: String): List[PluginBase] = error("unimplemented")
+
 }

distage/distage-extension-plugins/src/main/scala-3/izumi/distage/plugins/PluginDef.scala

@@ -0,0 +1,5 @@
+package izumi.distage.plugins
+
+package object load {
+  private[load] type PluginDefType = PluginDef
+}

distage/distage-extension-plugins/src/main/scala-3/izumi/distage/plugins/StaticPluginLoader.scala

@@ -1,7 +1,7 @@
 package izumi.distage.plugins.load
 
 import io.github.classgraph.ClassGraph
-import izumi.distage.plugins.{PluginBase, PluginConfig, PluginDef}
+import izumi.distage.plugins.{PluginBase, PluginConfig}
 import izumi.fundamentals.platform.cache.SyncCache
 import izumi.fundamentals.reflection.TypeUtil
 
@@ -25,7 +25,7 @@ class PluginLoaderDefaultImpl extends PluginLoader {
     val disabledPackages = config.packagesDisabled
 
     val pluginBase = classOf[PluginBase]
-    val pluginDef = classOf[PluginDef[?]]
+    val pluginDef = classOf[PluginDefType]
     val whitelistedClasses = Seq(pluginDef.getName)
 
     def loadPkgs(pkgs: Seq[String]): Seq[PluginBase] = {

distage/distage-extension-plugins/src/main/scala-3/izumi/distage/plugins/load/package.scala

@@ -8,4 +8,4 @@ import izumi.fundamentals.platform.build.ExposedTestScope
   * This is just to verify that plugin enumerator picks up transitively inherited plugins
   */
 @ExposedTestScope
-abstract class SneakyPlugin[T]()(implicit val ev: ForcedRecompilationToken[T]) extends PluginBase with ModuleDef
+abstract class SneakyPlugin[T](implicit val ev: ForcedRecompilationToken[T]) extends PluginBase with ModuleDef

distage/distage-extension-plugins/src/main/scala/izumi/distage/plugins/load/PluginLoaderDefaultImpl.scala

@@ -0,0 +1,11 @@
+package com.github.pshirshov.test.sneaky
+
+import izumi.distage.model.definition.ModuleDef
+import izumi.distage.plugins.{ForcedRecompilationToken, PluginBase}
+import izumi.fundamentals.platform.build.ExposedTestScope
+
+/**
+  * This is just to verify that plugin enumerator picks up transitively inherited plugins
+  */
+@ExposedTestScope
+abstract class SneakyPlugin(implicit val ev: ForcedRecompilationToken[?]) extends PluginBase with ModuleDef

distage/distage-extension-plugins/src/test/scala/com/github/pshirshov/test/sneaky/SneakyPlugin.scala renamed to distage/distage-extension-plugins/src/test/scala-2/com/github/pshirshov/test/sneaky/SneakyPlugin.scala

@@ -4,14 +4,14 @@ import com.github.pshirshov.test.sneaky.SneakyPlugin
 import izumi.fundamentals.platform.build.ExposedTestScope
 
 @ExposedTestScope
-class DependingPlugin extends SneakyPlugin() {
+class DependingPlugin extends SneakyPlugin {
   make[String].from((_: TestDep, _: TestDep3, _: TestService) => "abc")
 }
 
 @ExposedTestScope
 object DependingPlugin extends App {
-  class NestedDoublePlugin extends SneakyPlugin()
-  object NestedDoublePlugin extends SneakyPlugin() {
+  class NestedDoublePlugin extends SneakyPlugin
+  object NestedDoublePlugin extends SneakyPlugin {
     make[TestDepending]
   }
 }

distage/distage-extension-plugins/src/test/scala-3/com/github/pshirshov/test/sneaky/SneakyPlugin.scala

@@ -2,4 +2,4 @@ package com.github.pshirshov.test.plugins
 
 import com.github.pshirshov.test.sneaky.SneakyPlugin
 
-object EmptyTestPlugin extends SneakyPlugin()
+object EmptyTestPlugin extends SneakyPlugin

distage/distage-extension-plugins/src/test/scala/com/github/pshirshov/test/plugins/DependingPlugin.scala

@@ -2,6 +2,6 @@ package com.github.pshirshov.test.plugins
 
 import com.github.pshirshov.test.sneaky.SneakyPlugin
 
-object ObjectTestPlugin extends SneakyPlugin() {
+object ObjectTestPlugin extends SneakyPlugin {
   make[TestDep3]
 }

distage/distage-extension-plugins/src/test/scala/com/github/pshirshov/test/plugins/EmptyTestPlugin.scala

@@ -11,7 +11,7 @@ object Test extends Axis {
 }
 
 @ExposedTestScope
-class StaticTestPlugin extends SneakyPlugin() with ConfigModuleDef {
+class StaticTestPlugin extends SneakyPlugin with ConfigModuleDef {
   make[TestDep].tagged(Test.X).from[TestDep1]
   make[TestDep].tagged(Test.Y).from[TestDep2]
   make[TestService]

distage/distage-extension-plugins/src/test/scala/com/github/pshirshov/test/plugins/ObjectTestPlugin.scala

@@ -29,7 +29,7 @@ class PgSvcExample(
   }
 }
 
-object DockerPlugin extends PluginDef() {
+object DockerPlugin extends PluginDef {
   include(DockerSupportModule[Task])
   make[DynamoDocker.Container].fromResource {
     DynamoDocker.make[Task]

distage/distage-extension-plugins/src/test/scala/com/github/pshirshov/test/plugins/StaticTestPlugin.scala

@@ -62,7 +62,7 @@ abstract class RoleAppMain[F[_]](
     *
     *       {{{
     *       override def pluginConfig: PluginConfig = {
-    *         super.pluginConfig overriddenBy new PluginDef() {
+    *         super.pluginConfig overriddenBy new PluginDef {
     *           make[MyComponentX]]
     *         }
     *       }

distage/distage-framework-docker/src/test/scala/izumi/distage/testkit/docker/fixtures/DockerPlugin.scala

@@ -33,7 +33,7 @@ class StaticTestMainLogIO2[F[+_, +_]: TagKK: Async2: DefaultModule2] extends Rol
     PluginConfig
       .cached("com.github.pshirshov.test.plugins")
       .++(staticTestMainPlugin[F[Throwable, _], F[Throwable, _]])
-      .++(new PluginDef() {
+      .++(new PluginDef {
         modify[StaticTestRole[F[Throwable, _]]]
           .addDependency[LogIO2[F]]
       })

distage/distage-framework/src/main/scala/izumi/distage/roles/RoleAppMain.scala

@@ -14,7 +14,7 @@ object Fixture2 {
     override protected def pluginConfig: PluginConfig = PluginConfig.cached("com.github.pshirshov.test2.plugins")
   }
 
-  final class TestPlugin extends PluginDef() with RoleModuleDef {
+  final class TestPlugin extends PluginDef with RoleModuleDef {
     make[Dep].tagged(Mode.Prod, Repo.Prod).from[DepGood]
     make[Dep].tagged(Mode.Prod, Repo.Dummy).from[DepGood]
 

distage/distage-framework/src/test/scala/com/github/pshirshov/test/plugins/StaticTestMain.scala

@@ -17,12 +17,12 @@ object Fixture3 {
 
   object TestRoleAppMainFailing extends RoleAppMain.LauncherIdentity {
     override protected def pluginConfig: PluginConfig = PluginConfig.cachedThisPkg
-    override protected def bootstrapPluginConfig: PluginConfig = PluginConfig.cached("com.github.pshirshov.test3.bootstrap") overriddenBy new PluginDef() {
+    override protected def bootstrapPluginConfig: PluginConfig = PluginConfig.cached("com.github.pshirshov.test3.bootstrap") overriddenBy new PluginDef {
       modify[BootstrapComponent].addDependency[UnsatisfiedDep]
     }
   }
 
-  final class TestPlugin extends PluginDef() with RoleModuleDef {
+  final class TestPlugin extends PluginDef with RoleModuleDef {
     makeRole[Fixture3Role]
   }
 

distage/distage-framework/src/test/scala/com/github/pshirshov/test2/plugins/Fixture2.scala

@@ -39,7 +39,7 @@ class RoleAppTest extends AnyWordSpec with WithProperties {
     "testservice.systemPropList.1" -> "222",
   )
 
-  class XXX_TestWhiteboxProbe extends PluginDef() {
+  class XXX_TestWhiteboxProbe extends PluginDef {
     val resources = new XXX_ResourceEffectsRecorder[IO]
     private var locator0: LocatorRef = null
     lazy val locator: Locator = locator0.get
@@ -89,7 +89,7 @@ class RoleAppTest extends AnyWordSpec with WithProperties {
               new TestPluginCatsIO,
               new AdaptedAutocloseablesCasePlugin,
               probe,
-              new PluginDef() {
+              new PluginDef {
                 make[TestResource[IO]].from[IntegrationResource0[IO]]
                 many[TestResource[IO]]
                   .ref[TestResource[IO]]

distage/distage-framework/src/test/scala/com/github/pshirshov/test3/plugins/Fixture3.scala

@@ -9,7 +9,7 @@ import izumi.fundamentals.platform.cli.model.raw.RawEntrypointParams
 import izumi.logstage.api.Log
 import izumi.logstage.api.logger.LogSink
 
-class AdaptedAutocloseablesCasePlugin extends PluginDef() {
+class AdaptedAutocloseablesCasePlugin extends PluginDef {
   make[AdaptedAutocloseablesCase]
   many[LogSink].add[BrokenSink]
   many[LogSink].add[BrokenSink2]

distage/distage-framework/src/test/scala/izumi/distage/roles/test/RoleAppTest.scala

@@ -10,7 +10,7 @@ import izumi.distage.roles.test.fixtures.Fixture._
 import izumi.distage.roles.test.fixtures.ResourcesPlugin._
 import izumi.fundamentals.platform.functional.Identity
 
-class ConflictPlugin extends PluginDef() {
+class ConflictPlugin extends PluginDef {
   make[Conflict].tagged(Mode.Prod).from[Conflict1]
   make[Conflict].tagged(Mode.Test).from[Conflict2]
   make[Conflict].from[Conflict3]
@@ -49,7 +49,7 @@ trait ResourcesPluginBase extends ModuleDef {
     .ref[JustResource3[IO]]
 }
 
-class ResourcesPlugin extends PluginDef() with ResourcesPluginBase {
+class ResourcesPlugin extends PluginDef with ResourcesPluginBase {
   make[XXX_ResourceEffectsRecorder[IO]]
 
   make[IntegrationResource0[IO]]

distage/distage-framework/src/test/scala/izumi/distage/roles/test/fixtures/AdaptedAutocloseablesCasePlugin.scala

@@ -14,7 +14,7 @@ import izumi.distage.roles.test.fixtures.roles.TestRole00.{IntegrationOnlyCfg, I
 import izumi.fundamentals.platform.resources.ArtifactVersion
 import izumi.reflect.TagK
 
-class TestPluginBase[F[_]: TagK] extends PluginDef() with ConfigModuleDef with RoleModuleDef {
+class TestPluginBase[F[_]: TagK] extends PluginDef with ConfigModuleDef with RoleModuleDef {
   tag(Mode.Prod)
 
   include(BundledRolesModule[F] overriddenBy new ModuleDef {