Reimplement Macros with Scala 3 metaprogramming #689

cchantep · 2022-01-04T20:02:29Z

Pull Request Checklist

Have you read through the contributor guidelines?
Have you signed the Lightbend CLA?
Have you squashed your commits?
Have you added copyright headers to new files?
Have you updated the documentation?
Have you added tests for any changed functionality?

Purpose

Reimplement Macros with Scala 3 metaprogramming.

Restore support of non case class (previously thanks to custom extractor/unapply, now using ProductOf/Conversion)
Restore support of non case object
Restore Value class support
Restore custom naming support (field & discriminator)

Background Context

First, supports same compile-time features as those provided by the Scala 2 macros.

Simple Dotty derivation not sufficient, use new meta-programming to wrap/adapt (mirror still used to resolve the class fields).

References

Are there any relevant issues / PRs / mailing lists discussions?

docs/manual/working/scalaGuide/main/json/code/ScalaJsonAutomatedSpec.scala

docs/manual/working/scalaGuide/main/json/code/ScalaJsonCombinatorsSpec.scala

docs/manual/working/scalaGuide/main/json/code/ScalaJsonSpec.scala

play-functional/src/main/scala/play/api/libs/functional/Alternative.scala

play-functional/src/main/scala/play/api/libs/functional/Applicative.scala

cchantep · 2022-01-08T21:42:26Z

play-json/shared/src/main/scala-2/play/api/libs/json/JsMacros.scala

@@ -139,7 +139,7 @@ private[json] trait JsValueMacros {

 }

-trait JsMacrosWithOptions extends JsMacros {
+trait JsMacrosWithOptions[Opts <: Json.MacroOptions] extends JsMacros {


Required for the Scala3 equivalent, not a compatibility issue for me, as compile-time

cchantep · 2022-01-08T22:11:25Z

play-json/shared/src/test/scala-2/play/api/libs/json/MacroScala2Spec.scala

@@ -12,179 +12,8 @@ import org.scalacheck.Gen
 class MacroScala2Spec extends AnyWordSpec with Matchers with org.scalatestplus.scalacheck.ScalaCheckPropertyChecks {
  import MacroScala2Spec._

-  "Reads" should {


Merge back to MacroSpec

cchantep · 2022-01-08T22:12:40Z

play-json/shared/src/test/scala/play/api/libs/json/JsonSharedSpec.scala

@@ -33,36 +33,34 @@ class JsonSharedSpec extends AnyWordSpec with Matchers with org.scalatestplus.sc
  "JSON" should {
    "equals JsObject independently of field order" in json { js =>
      js.obj(
-          "field1" -> 123,


Source formatting

cchantep · 2022-01-08T22:13:31Z

play-json/shared/src/test/scala/play/api/libs/json/MacroSpec.scala

@@ -9,6 +9,7 @@ import Matchers._
 import org.scalatest.wordspec.AnyWordSpec

 object TestFormats {
+


Source formatting + restore common specs for Scala 2/3

cchantep · 2022-01-08T22:13:51Z

project/Common.scala

@@ -11,11 +11,11 @@ object Common extends AutoPlugin {

  override def globalSettings =
    Seq(
-      organization := "com.typesafe.play",


Source formatting

cchantep · 2022-01-09T12:50:55Z

.scalafmt.conf

+}
+
+project.excludePaths = [
+  "glob:**/docs/**/code*/*.scala"


Make sure special comment to extract snipped are unchanged (special comment a doc delimiters)

cchantep · 2022-01-09T12:52:24Z

play-json/shared/src/test/scala-3/play/api/libs/json/MacroScala3Spec.scala

+      }
+
+      "no custom ProductOf" in {
+        "Macros.writer[CustomNoProductOf]".mustNot(typeCheck)


Conversion alone is not sufficient

AlexITC · 2022-01-14T03:08:58Z

Are there any plans to consider merging this anytime soon? @playframework/contributors

BillyAutrey · 2022-01-15T15:03:11Z

Are there any plans to consider merging this anytime soon? @playframework/contributors

Just for transparency here, we asked that Cédric split up the PR. Separating the large amount of formatting changes from the relevant code makes it easier to review.

cchantep · 2022-02-28T08:23:37Z

Up

mkurz · 2022-03-10T23:41:34Z

Please fix the conflicts ,thanks!

cchantep · 2022-03-11T10:26:00Z

Please fix the conflicts ,thanks!

Approval required

godenji · 2022-03-14T00:52:25Z

Thanks for pushing this forward @cchantep

After this is merged (hopefully soon!), when can we expect a new release? I've been working off of the 2.10.0-RC5 release in a Scala 3 project; it's 100+ commits behind main at this point...

mkurz · 2022-03-15T09:43:45Z

OK, I am going to merge this and release 2.10.0-RC6 so people can start testing

cchantep · 2022-03-15T10:52:23Z

It would have been nice that I was able to merge it myself (as core contributor for "quite sometime") ...

mkurz · 2022-03-15T11:13:26Z

It would have been nice that I was able to merge

You can do now.

xuwei-k · 2022-03-16T03:47:24Z

2.10.0-RC6 macro does not support large case class (throw ClassNotFoundException: scala.Tuple25) #728

😭

cchantep force-pushed the task/scala3 branch 20 times, most recently from 4f31838 to 63913dc Compare January 8, 2022 21:38

cchantep commented Jan 8, 2022

View reviewed changes

cchantep force-pushed the task/scala3 branch 3 times, most recently from 8ff60d8 to 03b2c25 Compare January 8, 2022 22:48

cchantep marked this pull request as ready for review January 8, 2022 22:56

cchantep changed the title ~~Draft: Reimplement Macros with Scala 3 metaprogramming~~ Reimplement Macros with Scala 3 metaprogramming Jan 8, 2022

cchantep commented Jan 9, 2022

View reviewed changes

cchantep force-pushed the task/scala3 branch from 36dadf1 to d022171 Compare January 11, 2022 19:33

cchantep disabled auto-merge February 28, 2022 08:20

cchantep force-pushed the task/scala3 branch from 5a79ba4 to e20e8e4 Compare March 11, 2022 09:08

cchantep added 13 commits March 11, 2022 10:09

Update Macro facade

8c661e4

Value class macros

0c34c45

Singleton reads macro

5e61ce4

WIP

7c3de57

productReads

b2c8b56

productWrites

59e9f60

Revert scalafmt changes

8b45dc1

Add unit test about quotes utilities

7700028

Add specs for simple/non-case class support by macros

8abe480

Add specs for objects support in macros

3a7ff17

Update tests for non-case class macro support

63909d5

Update documentation & add Scala 3 specific tests for custom class

001b00c

Revert

bd7cec4

cchantep force-pushed the task/scala3 branch from e20e8e4 to 18d35d8 Compare March 11, 2022 09:11

Review

61a100e

cchantep force-pushed the task/scala3 branch from 18d35d8 to 61a100e Compare March 11, 2022 09:38

cchantep enabled auto-merge (squash) March 11, 2022 10:23

cchantep disabled auto-merge March 11, 2022 10:25

mkurz merged commit d841976 into playframework:main Mar 15, 2022

cchantep deleted the task/scala3 branch March 15, 2022 10:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reimplement Macros with Scala 3 metaprogramming #689

Reimplement Macros with Scala 3 metaprogramming #689

cchantep commented Jan 4, 2022 •

edited

Loading

cchantep Jan 8, 2022

cchantep Jan 8, 2022

cchantep Jan 8, 2022

cchantep Jan 8, 2022

cchantep Jan 8, 2022

cchantep Jan 9, 2022

cchantep Jan 9, 2022

AlexITC commented Jan 14, 2022

BillyAutrey commented Jan 15, 2022

cchantep commented Feb 28, 2022

mkurz commented Mar 10, 2022

cchantep commented Mar 11, 2022

godenji commented Mar 14, 2022

mkurz commented Mar 15, 2022

cchantep commented Mar 15, 2022

mkurz commented Mar 15, 2022

xuwei-k commented Mar 16, 2022

		@@ -9,6 +9,7 @@ import Matchers._
		import org.scalatest.wordspec.AnyWordSpec

		object TestFormats {

Reimplement Macros with Scala 3 metaprogramming #689

Reimplement Macros with Scala 3 metaprogramming #689

Conversation

cchantep commented Jan 4, 2022 • edited Loading

Pull Request Checklist

Purpose

Background Context

References

cchantep Jan 8, 2022

Choose a reason for hiding this comment

cchantep Jan 8, 2022

Choose a reason for hiding this comment

cchantep Jan 8, 2022

Choose a reason for hiding this comment

cchantep Jan 8, 2022

Choose a reason for hiding this comment

cchantep Jan 8, 2022

Choose a reason for hiding this comment

cchantep Jan 9, 2022

Choose a reason for hiding this comment

cchantep Jan 9, 2022

Choose a reason for hiding this comment

AlexITC commented Jan 14, 2022

BillyAutrey commented Jan 15, 2022

cchantep commented Feb 28, 2022

mkurz commented Mar 10, 2022

cchantep commented Mar 11, 2022

godenji commented Mar 14, 2022

mkurz commented Mar 15, 2022

cchantep commented Mar 15, 2022

mkurz commented Mar 15, 2022

xuwei-k commented Mar 16, 2022

cchantep commented Jan 4, 2022 •

edited

Loading