Mix scala 2 and 3 macros #395

gregghz · 2024-05-21T21:40:10Z

This follows the pattern shown here: https://docs.scala-lang.org/scala3/guides/migration/tutorial-macro-mixing.html#:~:text=Introduction,during%20the%20macro%20expansion%20phase

This would allow a mixed scala version project to depend on the scala 3 version of enumeratum and build correctly for both scala 2 modules and scala 3 modules. This is particularly helpful when building with bazel since you can't conditionally include a dependency based on the current scala version the same way you would in sbt.

This was brought up previously by @coreywoodfield here: #300 (comment) (and he is the author of this PR -- I just rebased the branch).

Scala 2 macros can be compiled in scala 3 only if they do not use reification or quasiquotes

lloydmeta · 2024-05-21T23:01:03Z

Thanks for the PR but can you please add a description for this that explains why we want this?

gregghz · 2024-05-21T23:08:23Z

@lloydmeta ah, thanks for taking a look. I've updated the description to clarify what's going on.

gregghz · 2024-09-20T21:52:27Z

@lloydmeta thanks for your patience with this. I just updated things again to hopefully resolve the build failures. I can't remember, were you manually triggering builds?

lloydmeta · 2024-09-21T02:22:36Z

Yea... I think I set something up once that requires me to approve the CI runs 🤦‍♂️

codecov-commenter · 2024-09-22T00:31:30Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.30%. Comparing base (10a084d) to head (69038cf).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #395      +/-   ##
==========================================
- Coverage   85.71%   85.30%   -0.41%     
==========================================
  Files          63       65       +2     
  Lines         511      599      +88     
  Branches       34       51      +17     
==========================================
+ Hits          438      511      +73     
- Misses         73       88      +15

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

lloydmeta

Thanks for doing this.

There are quite a lot of changes that do not feel necessary, some of which are IMO a step backwards. My request would be to remove any changes that are not absolutely necessary.

lloydmeta · 2024-09-22T08:10:57Z

.github/workflows/ci.yml

          - java: 11
-            scala: 3.3.0
+            scala: 3.4.0


This is not an LTS release. Let's revert this.

Unfortunately, this PR won't work with scala < 3.4 because of scala/scala3#16630

They mentioned backporting to 3.3.1-RC1 but seems like that never happened. It was also mentioned briefly here: #300 (comment)

Understood. That is a blocker indeed.

Makes sense. I tested this out using scala 3.3.4-RC4 and it does build succesfully with that version. So once 3.3.4 gets released I'll udpate this PR.

this is fixed now. 3.3.4 was released.

lloydmeta · 2024-09-22T08:11:13Z

.scalafmt.conf

@@ -1,4 +1,4 @@
-version = 3.7.8
+version = 3.7.17


Was this needed?

Seems like no, I'll revert.

I changed this to 3.7.10 because without that update, in sbt ++3.3.4 test:compile fails with:

[error] (coreJS / Compile / scalafmt) org.scalafmt.sbt.ScalafmtSbtReporter$ScalafmtSbtError: scalafmt: /home/gregg/lucid/enumeratum/enumeratum-core/src/main/scala-3/enumeratum/EnumCompat.scala:14: error: [dialect scala3] pattern must be a value or have parens: EnumMacros.findValuesImpl[A] [error] protected inline def findValues: IndexedSeq[A] = ${ EnumMacros.findValuesImpl[A] } [error] ^ [/home/gregg/lucid/enumeratum/enumeratum-core/src/main/scala-3/enumeratum/EnumCompat.scala]

there and a few other places.

lloydmeta · 2024-09-22T08:11:20Z

build.sbt

-lazy val scala_2_13Version = "2.13.11"
-lazy val scala_3Version    = "3.3.0"
+lazy val scala_2_13Version = "2.13.13"
+lazy val scala_3Version    = "3.4.0"


Please revert.

lloydmeta · 2024-09-22T08:11:53Z

build.sbt

-        "org.scala-lang" %% "scala3-compiler" % scalaVersion.value % Provided
+        Seq(
+          "org.scala-lang" %% "scala3-compiler" % scalaVersion.value % Provided,
+          "org.scala-lang" % "scala-reflect" % scala_2_13Version,


Curious if there's a way to make this additional dependency

Contingent on actually using the mix mode macro

Only a compile time constraint?

Unfortunately I think only the consumer of the library knows if the mixed mode macro is being used, from here, sbt only knows that it's a scala3 build.

I believe we could mark this as Provided too, but then all consumers would need to explicitly provide it. Marking it provided here means I also need to add it as Provided in core. It would only need to be added as a normal/runtime dep if the project was using the mixed mode because I think this is only needed for the scala 2 portion of the build.

@lloydmeta let me know if you have a preference here.

lloydmeta · 2024-09-22T08:12:12Z

build.sbt

@@ -685,7 +688,7 @@ lazy val compilerSettings = Seq(

    val base = {
      if (scalaBinaryVersion.value == "3") {
-        minimal :+ "-deprecation"
+        minimal :+ "-Wconf:cat=deprecation:s"


Curious why this was needed?

[error] -- Error: /home/gregg/lucid/enumeratum/macros/src/main/scala/enumeratum/compat/EnumMacros.scala:109:32 [error] 109 | val enclosingModule = c.enclosingClass match { [error] | ^^^^^^^^^^^^^^^^ [error] |method enclosingClass in trait Enclosures is deprecated since 2.11.0: c.enclosingTree-style APIs are now deprecated; consult the scaladoc for more information

and a few more identical errors

lloydmeta · 2024-09-22T08:13:12Z

enumeratum-core/src/main/scala-3/enumeratum/EnumCompat.scala

@@ -8,7 +11,8 @@ private[enumeratum] trait EnumCompat[A <: EnumEntry] { _enum: Enum[A] =>
    * You will want to use this in some way to implement your [[values]] method. In fact, if you
    * aren't using this method... why are you even bothering with this lib?
    */
-  inline def findValues: IndexedSeq[A] = ${ EnumMacros.findValuesImpl[A] }
+  protected inline def findValues: IndexedSeq[A] = ${ EnumMacros.findValuesImpl[A] }


Curious why this is now protected.

I'm not sure. I reverted it.

lloydmeta · 2024-09-22T08:13:54Z

enumeratum-core/src/main/scala/enumeratum/EnumEntry.scala

@@ -19,7 +19,7 @@ trait EnumEntry {
    */
  def entryName: String = stableEntryName

-  private[this] lazy val stableEntryName: String = toString
+  private lazy val stableEntryName: String = toString


Was this (and below) removals of this needed?

the scala 3 build fails without removing these (deprecated feature)

lloydmeta · 2024-09-22T08:14:02Z

enumeratum-play/src/main/scala/enumeratum/values/Forms.scala

@@ -9,7 +9,7 @@ import play.api.data.{FormError, Mapping, Forms => PlayForms}
  */
 object Forms extends FormsCompat {

-  protected[this] def formatter[ValueType, EntryType <: ValueEnumEntry[
+  protected def formatter[ValueType, EntryType <: ValueEnumEntry[


lloydmeta · 2024-09-22T08:14:55Z

macros/src/main/scala/enumeratum/compat/EnumMacros.scala

@@ -10,7 +11,7 @@ object EnumMacros {

  /** Finds any [A] in the current scope and returns an expression for a list of them
    */
-  def findValuesImpl[A: c.WeakTypeTag](c: Context): c.Expr[IndexedSeq[A]] = {
+  def findValuesImpl[A: c.WeakTypeTag](c: Context): c.Tree = {


Was this needed? Feels like a step backwards to lose type info, so if it's not required, please revert.

lloydmeta · 2024-09-22T08:15:06Z

macros/src/main/scala/enumeratum/compat/ValueEnumMacros.scala

Same question regarding type change for everything here.

coreywoodfield added 2 commits May 21, 2024 13:02

Update scala 2 macros to not use reification

7b14325

Scala 2 macros can be compiled in scala 3 only if they do not use reification or quasiquotes

Mix scala 2 and scala 3 macros

947a593

gregghz and others added 3 commits May 27, 2024 12:02

Update scala version for CI

0a43847

Update dependencies to fix builds

724cb52

Merge branch 'master' into mix-scala-2-and-3-macros

519b37b

update scoverage for scala 2.13.13

69038cf

lloydmeta requested changes Sep 22, 2024

View reviewed changes

Gregg Hernandez and others added 6 commits October 25, 2024 13:47

Use latest scala lts

94740e3

Revert scalafmt version

beff0d6

Suppress deprecation warning

719ad73

Update scalafmt

0f8dfca

Merge branch 'master' into mix-scala-2-and-3-macros

ad41604

Removes protected

58feb27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mix scala 2 and 3 macros #395

Mix scala 2 and 3 macros #395

gregghz commented May 21, 2024 •

edited

Loading

lloydmeta commented May 21, 2024

gregghz commented May 21, 2024

gregghz commented Sep 20, 2024

lloydmeta commented Sep 21, 2024

codecov-commenter commented Sep 22, 2024

lloydmeta left a comment

lloydmeta Sep 22, 2024

gregghz Sep 23, 2024

lloydmeta Sep 24, 2024

gregghz Sep 26, 2024

gregghz Oct 25, 2024

lloydmeta Sep 22, 2024

gregghz Oct 9, 2024

gregghz Oct 25, 2024

gregghz Oct 25, 2024

lloydmeta Sep 22, 2024

gregghz Oct 25, 2024

lloydmeta Sep 22, 2024

gregghz Oct 9, 2024

gregghz Oct 25, 2024

lloydmeta Sep 22, 2024

gregghz Oct 9, 2024

lloydmeta Sep 22, 2024

gregghz Oct 31, 2024

lloydmeta Sep 22, 2024

gregghz Sep 23, 2024

lloydmeta Sep 22, 2024

lloydmeta Sep 22, 2024

lloydmeta Sep 22, 2024

Mix scala 2 and 3 macros #395

Are you sure you want to change the base?

Mix scala 2 and 3 macros #395

Conversation

gregghz commented May 21, 2024 • edited Loading

lloydmeta commented May 21, 2024

gregghz commented May 21, 2024

gregghz commented Sep 20, 2024

lloydmeta commented Sep 21, 2024

codecov-commenter commented Sep 22, 2024

Codecov Report

lloydmeta left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gregghz commented May 21, 2024 •

edited

Loading