Ignore private constructors #778

jeroentervoorde · 2023-08-09T07:18:13Z

I've added a classPrivate flag in the same fashion as the scopedPrivate flag and got it value from the pickled flags.
This works for normal classes with private constructors as demonstrated by the test but I could use some input if there are other constructs that would require additional unit tests.

Case classes work as well but they need the -Xsource:3 option and private unapply (as documented here) to pass.
I could add a test for that, either by making it a nok test or by adding some way to enable the -Xsource:3 option for that specific test.

I also enabled the doMethodOverloads in MimaUnpicker for constructors as well which was commented out with a todo.
A side effect is that private[...] constructors are now also ignored (using the existing isScopedPrivate flag) but I'm not actually sure this is the wanted behaviour. If not I propose to add a doConstructorOverloads that only checks the classPrivate flag and either keep doMethodOverloads as is or also include the check for classPrivate is done in the PR.

References #738

This enables the doMethodOverloads in MimaUnpicker for constructors as well which was commented out with a todo.

…rivate constructors.

…on field on the case class. This also fixed binary compatibility of mima-core.

jeroentervoorde · 2023-08-11T06:52:54Z

The build failed due to binary compatibility problems caused by an additional field in DefDef in the TastyUnpickler.

I don't really see a way to avoid this. I've added the problems to the mima filters for now.
Not sure if DefDef is/should be part of the public api.

…DefDef to the mima filters.

SethTisue · 2023-09-10T21:08:46Z

I'm sorry we haven't found a reviewer for this yet. I know it's discouraging to work on something and then get weeks of silence. Sadly, MiMa is without a primary owner at present. It has had a series of them in the past, but they've moved on to other things.

If I can't find someone more knowledgeable than myself to review it before too much longer, I'll take a look and presumably optimistically-merge it before too much longer. (But not this week, busy with Scala Days.)

julienrf

Thank you @jeroentervoorde for the pull request!

I am not familiar with the codebase but the approach looks good to me, although I am not sure about the changes in TastyUnpickler.scala. It would be good to get feedback from someone more experienced with the project.

I agree that adding a test with a case class and -Xsource:3 would be amazing!

core/src/main/scala/com/typesafe/tools/mima/core/TastyUnpickler.scala

julienrf · 2023-09-17T16:57:35Z

core/src/main/scala/com/typesafe/tools/mima/core/TastyUnpickler.scala

+  def copyClassPrivate(tree: Tree, pkgInfo: PackageInfo): Unit = new ClassTraverser(pkgInfo) {
+    override def forEachClass(clsDef: ClsDef, cls: ClassInfo): Unit = {
+    }
+
+    override def traverseTemplate(tmpl: Template): Unit = {
+      super.traverseTemplate(tmpl)
+      doMethods(tmpl)
+    }
+
+    def doMethods(tmpl: Template) = {
+      val clazz = currentClass
+      tmpl.meths.iterator
+        .toSeq.groupBy(_.name).foreach { case (name, pickleMethods) =>
+          doMethodOverloads(clazz, name, pickleMethods)
+        }
+    }
+
+    def doMethodOverloads(clazz: ClassInfo, name: Name, pickleMethods: Seq[DefDef]) = {
+      val bytecodeMethods = clazz.methods.get(name.source).filter(!_.isBridge).toList
+      if (pickleMethods.size == bytecodeMethods.size && pickleMethods.exists(_.classPrivate)) {
+        bytecodeMethods.zip(pickleMethods).foreach { case (bytecodeMeth, pickleMeth) =>
+          bytecodeMeth.classPrivate = pickleMeth.classPrivate
+        }
+      }
+    }
+  }.traverse(tree)


Could you please explain why it is not possible to do the job in copyPrivateWithin? I am a bit lost.

I looked into it a bit more and actually was possible. The classPrivate flags are now also copied for ValDefs but I guess that's ok.

To make this work: - Added option to skip tests (using skip-${binaryVersion}.txt) - Added support for scala-options-${binaryVersion}.txt) which can be used to set -Xsource:3 (or other scalac options)

jeroentervoorde · 2023-09-28T16:42:28Z

I did add a test for the private constructor change. I had to add some new functionality to the test runner though:

Tests can now be skipped by adding a "skip-${version}.txt" file.
Scalac options can be set using a "scalac-options-${version}.txt" file.

I also noticed that i did not get a warning for the unapply method in scala 3 as the signature doesn't actually change anymore (at least in my test). Is this always the case with scala 3?

julienrf · 2023-09-28T18:31:13Z

I also noticed that i did not get a warning for the unapply method in scala 3 as the signature doesn't actually change anymore (at least in my test). Is this always the case with scala 3?

Yes. I think weird things could happen at run-time, but the type signature is the same.

julienrf · 2023-12-07T22:33:00Z

@dwijnand would you be interested in reviewing this PR?

dwijnand

LGTM, thank you @jeroentervoorde !

The comment is outdated as the issue was fixed in MiMa: lightbend-labs/mima#778

jeroentervoorde added 2 commits August 8, 2023 17:08

Ignore package private constructors in checks.

acee8fd

This enables the doMethodOverloads in MimaUnpicker for constructors as well which was commented out with a todo.

Implement classPrivate flag on MemberInfo to check accessibility of p…

a591913

…rivate constructors.

jeroentervoorde changed the title ~~Private constructors~~ Ignore private constructors Aug 9, 2023

Reuse the flags in SymbolInfo for isClassPrivate instead of an additi…

666a8e8

…on field on the case class. This also fixed binary compatibility of mima-core.

jeroentervoorde marked this pull request as draft August 10, 2023 14:22

Also implemented the changes for the TastyPickler.

a5dc093

jeroentervoorde added 2 commits August 14, 2023 11:02

Removed unused variable

ed0345b

Added bin compat problems caused by adding the classPrivate field to …

ac0f7ee

…DefDef to the mima filters.

jeroentervoorde marked this pull request as ready for review August 17, 2023 09:46

jeroentervoorde mentioned this pull request Aug 31, 2023

Private class constructors should be ignored #738

Closed

julienrf reviewed Sep 17, 2023

View reviewed changes

jeroentervoorde added 4 commits September 28, 2023 17:57

Merged copyPrivateWithin and copyClassPrivate in TastyUnpickler.

067599c

Added test for private constructor change in case classes.

ef3ff85

To make this work: - Added option to skip tests (using skip-${binaryVersion}.txt) - Added support for scala-options-${binaryVersion}.txt) which can be used to set -Xsource:3 (or other scalac options)

Merge remote-tracking branch 'lightbend/main' into private-constructors

79dbde2

Added a bunch more problemfilters for the changes in TastyUnpickler.

1364a2d

dwijnand approved these changes Dec 11, 2023

View reviewed changes

dwijnand merged commit 68f6dc6 into lightbend-labs:main Dec 11, 2023
11 checks passed

daddykotex added a commit to daddykotex/docs.scala-lang that referenced this pull request Jan 23, 2024

Update binary-compatibility-for-library-authors.md

a3f27f6

The comment is outdated as the issue was fixed in MiMa: lightbend-labs/mima#778

daddykotex mentioned this pull request Jan 23, 2024

Update binary-compatibility-for-library-authors.md scala/docs.scala-lang#2951

Closed

mr-git mentioned this pull request Jun 17, 2024

Stop actor after persisting events failed evolution-gaming/akka-effect#319

Merged

SethTisue mentioned this pull request Jun 20, 2024

Roll a release (1.1.4) #816

Closed

raboof mentioned this pull request Jun 22, 2024

AMQP: Avoid allocating a new ByteString on each consumed message apache/pekko-connectors#592

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ignore private constructors #778

Ignore private constructors #778

jeroentervoorde commented Aug 9, 2023

jeroentervoorde commented Aug 11, 2023 •

edited

Loading

SethTisue commented Sep 10, 2023 •

edited

Loading

julienrf left a comment

julienrf Sep 17, 2023

jeroentervoorde Sep 28, 2023

jeroentervoorde commented Sep 28, 2023

julienrf commented Sep 28, 2023

julienrf commented Dec 7, 2023

dwijnand left a comment

Ignore private constructors #778

Ignore private constructors #778

Conversation

jeroentervoorde commented Aug 9, 2023

jeroentervoorde commented Aug 11, 2023 • edited Loading

SethTisue commented Sep 10, 2023 • edited Loading

julienrf left a comment

Choose a reason for hiding this comment

julienrf Sep 17, 2023

Choose a reason for hiding this comment

jeroentervoorde Sep 28, 2023

Choose a reason for hiding this comment

jeroentervoorde commented Sep 28, 2023

julienrf commented Sep 28, 2023

julienrf commented Dec 7, 2023

dwijnand left a comment

Choose a reason for hiding this comment

jeroentervoorde commented Aug 11, 2023 •

edited

Loading

SethTisue commented Sep 10, 2023 •

edited

Loading