Enable MiMa for Scala 3 #4063

armanbilge · 2021-12-01T20:42:20Z

Will also fix #4062. First commit should fail to demonstrate MiMa is running.

joroKr21 · 2021-12-01T21:05:37Z

build.sbt

@@ -348,9 +348,12 @@ def mimaPrevious(moduleName: String, scalaVer: String, ver: String, includeCats1
  lazy val excludedVersions: List[String] = List()

  // Safety Net for Inclusions
-  lazy val extraVersions: List[String] = List("1.0.1", "1.1.0", "1.2.0", "1.3.1", "1.4.0", "1.5.0", "1.6.1")
+  lazy val extraCats1Versions: List[String] = List("1.0.1", "1.1.0", "1.2.0", "1.3.1", "1.4.0", "1.5.0", "1.6.1")


Btw checking so old versions doesn't cover new definitions (added since).
IMO we should check against the latest previous version.

We are, these are just extras :) in sbt try show coreJVM/mimaPreviousArtifacts to see the list.

Oh ok I see 👍 - why do we add the extras? To be extra sure?

johnynek · 2021-12-01T21:16:35Z

build.sbt

    libraryDependencies += mimaPrevious("cats-core", scalaVersion.value, version.value).last % Provided,
-    scalacOptions ++= (if (priorTo2_13(scalaVersion.value)) Seq("-Ypartial-unification") else Nil)
+    scalacOptions ++= (if (priorTo2_13(scalaVersion.value)) Seq("-Ypartial-unification") else Nil),
+    scalacOptions ++= (if (isDotty.value) Seq("-Ykind-projector") else Nil)


is this the right order? isn't it if (!isDotty.value)?

Not sure TBH, but this works for 2.x and 3 locally.

See also https://docs.scala-lang.org/scala3/guides/migration/plugin-kind-projector.html

armanbilge · 2021-12-01T21:24:58Z

binCompatTest/src/main/scala/catsBC/MimaExceptions.scala

-    FunctionK.lift(headOption),
+    // FunctionK.lift(headOption), // Doesn't work in Scala 3


Anyone know anything about this?

That's a macro which is not implemented for Scala 3:
https://github.com/typelevel/cats/blob/main/core/src/main/scala-2.x/src/main/scala/cats/arrow/FunctionKMacros.scala

Is it okay to disable, or maybe we should split this test into Scala 2 / Scala 3?

I'm not sure what this is testing TBH

armanbilge · 2021-12-01T21:25:39Z

build.sbt

-  lazy val excludedVersions: List[String] = List()
+  lazy val excludedVersions: List[String] = List("2.7.0") // cursed bincompat on Scala 3


2.7.0 is cursed right? Unless we only want to curse it for Scala 3.

armanbilge · 2021-12-01T22:05:40Z

How do we feel about static methods for Java? @johnynek you pushed for conservatism in typelevel/cats-effect#2343 (comment).

[error] Cats core: Failed binary compatibility check against org.typelevel:cats-core_2.13:2.6.1! Found 2 potential problems
[error]  * static method catsInstancesForId()cats.Distributive in interface cats.Invariant does not have a correspondent in current version
[error]    filter with: ProblemFilters.exclude[DirectMissingMethodProblem]("cats.Invariant.catsInstancesForId")
[error]  * static method catsInstancesForId()cats.Bimonad in class cats.package does not have a correspondent in current version
[error]    filter with: ProblemFilters.exclude[DirectMissingMethodProblem]("cats.package.catsInstancesForId")

joroKr21 · 2021-12-01T22:17:50Z

That's the issue in #4062 we were discussing though - the issue is that the type signature changed.

armanbilge · 2021-12-01T22:20:13Z

Yes, except it's now fixed for Scala. However, by marking the old method private[cats] dissapears the static forwarders which AFAIK are only used by Java. That's what MiMa is complaining about, not the non-static methods that originally brought our attention to this issue. Also note this is 2.13 and not 3.

joroKr21 · 2021-12-01T22:25:18Z

core/src/main/scala/cats/package.scala

+  @deprecated("retained for binary compatibility", "2.7.1")
+  private[cats] def catsInstancesForId
+    : Bimonad[Id] with CommutativeMonad[Id] with Comonad[Id] with NonEmptyTraverse[Id] with Distributive[Id] =
+    catsInstancesForIdBinCompat1
+  val catsInstancesForIdBinCompat1
+    : Bimonad[Id] with CommutativeMonad[Id] with NonEmptyTraverse[Id] with Distributive[Id] =


Why do we need this change? 🤔 - I thought only the forwarder in Invariant needs a change

joroKr21 · 2021-12-01T22:30:45Z

Here is another suggestion - add one more forwarder of type Bimonad[Id] with CommutativeMonad[Id] to object Monad and restore the old type of the forwarder in object Invariant 😄 - or should it be to Applicative? Sorry, that's tricky.

Edit: I think it should be in Functor

smarter · 2021-12-01T22:46:38Z

I wonder if bincompat with both cats-2.6.1_3 and cats-2.7.0_3 could be kept using @targetName to generate overloads (requiring a scala-2/ and scala-3/ version of the original file):

import scala.annotation.targetName
// ...
// 2.6.1 compat
private[cats] def catsInstancesForId: Distributive[Id] with Comonad[Id] = ...
// 2.7.0 compat
private[cats] @targetName("catsInstancesForId") def catsInstancesForIdCompat270:
     : Distributive[Id] with Bimonad[Id] with CommutativeMonad[Id] with NonEmptyTraverse[Id] = ...
// new method
implicit def catsInstancesForIdBinCompat1
    : Distributive[Id] with Bimonad[Id] with CommutativeMonad[Id] with NonEmptyTraverse[Id] = ...

satorg · 2021-12-01T23:42:49Z

I wonder if bincompat with both cats-2.6.1_3 and cats-2.7.0_3 could be kept using @targetName to generate overloads (requiring a scala-2/ and scala-3/ version of the original file):

But this annotation only exists in Scala3's library, right?

smarter · 2021-12-02T08:22:19Z

Yes, that would be in a scala-3/ version of the file, the scala-2/ version only needs one version of catsInstancesForId to keep compat with 2.6.1 and 2.7.0.

armanbilge · 2021-12-23T13:48:02Z

So, while main has moved on to 2.8.0-SNAPSHOT I'm wondering if we should make a patch release of 2.7.1 with this bincompat fixed. Because otherwise, the 2.7 series will be a (small, Scala 3-only) break in the binary-compatibility of the 2.x series as a whole.

satorg · 2022-01-27T18:22:57Z

@armanbilge just curious – is this PR still in progress?

armanbilge · 2022-01-27T18:24:11Z

This PR needs feedback on the following to proceed:

satorg · 2022-01-28T05:12:04Z

So, while main has moved on to 2.8.0-SNAPSHOT I'm wondering if we should make a patch release of 2.7.1 with this bincompat fixed. ...

I would say no need to patch 2.7.x unless there're complains from people who use it in some prod-ish projects and encountered issues with. But I guess if there were such issues we would already know about it.

satorg · 2022-01-28T05:18:37Z

I wonder if bincompat with both cats-2.6.1_3 and cats-2.7.0_3 could be kept using @TargetNAME to generate overloads.

From my prospective, if it is possible to maintain bin.compatibility without spitting sources into Scala2 and Scala3 versions then it would be the best bet. But I realize that in some cases it may not be feasible – then @targetName can come in handy of course.

armanbilge · 2022-04-04T06:07:49Z

Superseded by #4160.

Enable MiMa for Scala 3

7c8578d

armanbilge marked this pull request as draft December 1, 2021 20:42

joroKr21 reviewed Dec 1, 2021

View reviewed changes

Fix validateBC for Scala 3

de49f0a

johnynek reviewed Dec 1, 2021

View reviewed changes

Fix catsInstancesForId bincompat on Scala 3

e8c4306

armanbilge commented Dec 1, 2021

View reviewed changes

More filters

7d23def

joroKr21 reviewed Dec 1, 2021

View reviewed changes

armanbilge mentioned this pull request Dec 3, 2021

Optimize Alternative (part 3): add prependK/appendK specializations for Cats NE wrappers #4055

Merged

armanbilge mentioned this pull request Jan 27, 2022

Opaque transformers types #3919

Closed

armanbilge mentioned this pull request Mar 7, 2022

Migrate build to sbt-typelevel #4143

Closed

armanbilge closed this Apr 4, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable MiMa for Scala 3 #4063

Enable MiMa for Scala 3 #4063

armanbilge commented Dec 1, 2021 •

edited

Loading

joroKr21 Dec 1, 2021

armanbilge Dec 1, 2021

joroKr21 Dec 1, 2021

armanbilge Dec 1, 2021

johnynek Dec 1, 2021

armanbilge Dec 1, 2021

armanbilge Dec 1, 2021

armanbilge Dec 1, 2021

joroKr21 Dec 1, 2021

armanbilge Dec 1, 2021

joroKr21 Dec 1, 2021

armanbilge Dec 1, 2021

armanbilge commented Dec 1, 2021

joroKr21 commented Dec 1, 2021

armanbilge commented Dec 1, 2021 •

edited

Loading

joroKr21 Dec 1, 2021

joroKr21 commented Dec 1, 2021 •

edited

Loading

smarter commented Dec 1, 2021

satorg commented Dec 1, 2021

smarter commented Dec 2, 2021

armanbilge commented Dec 23, 2021

satorg commented Jan 27, 2022

armanbilge commented Jan 27, 2022

satorg commented Jan 28, 2022

satorg commented Jan 28, 2022

armanbilge commented Apr 4, 2022

		FunctionK.lift(headOption),
		// FunctionK.lift(headOption), // Doesn't work in Scala 3

		lazy val excludedVersions: List[String] = List()
		lazy val excludedVersions: List[String] = List("2.7.0") // cursed bincompat on Scala 3

Enable MiMa for Scala 3 #4063

Enable MiMa for Scala 3 #4063

Conversation

armanbilge commented Dec 1, 2021 • edited Loading

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

armanbilge commented Dec 1, 2021

joroKr21 commented Dec 1, 2021

armanbilge commented Dec 1, 2021 • edited Loading

Choose a reason for hiding this comment

joroKr21 commented Dec 1, 2021 • edited Loading

smarter commented Dec 1, 2021

satorg commented Dec 1, 2021

smarter commented Dec 2, 2021

armanbilge commented Dec 23, 2021

satorg commented Jan 27, 2022

armanbilge commented Jan 27, 2022

satorg commented Jan 28, 2022

satorg commented Jan 28, 2022

armanbilge commented Apr 4, 2022

armanbilge commented Dec 1, 2021 •

edited

Loading

armanbilge commented Dec 1, 2021 •

edited

Loading

joroKr21 commented Dec 1, 2021 •

edited

Loading