Add MiMa to stdlib-bootstrapped

Author: nicolasstucki

.github/workflows/ci.yaml

@@ -253,7 +253,7 @@ jobs:
 
       - name: MiMa
         run: |
-          ./project/scripts/sbt ";scala3-interfaces/mimaReportBinaryIssues ;scala3-library-bootstrapped/mimaReportBinaryIssues ;scala3-library-bootstrappedJS/mimaReportBinaryIssues; tasty-core-bootstrapped/mimaReportBinaryIssues"
+          ./project/scripts/sbt ";scala3-interfaces/mimaReportBinaryIssues ;scala3-library-bootstrapped/mimaReportBinaryIssues ;scala3-library-bootstrappedJS/mimaReportBinaryIssues; tasty-core-bootstrapped/mimaReportBinaryIssues; stdlib-bootstrapped/mimaReportBinaryIssues"
 
   community_build_a:
     runs-on: [self-hosted, Linux]

project/Build.scala

@@ -1021,6 +1021,15 @@ object Build {
       (Test / managedClasspath) ~= {
         _.filterNot(file => file.data.getName == s"scala-library-${stdlibVersion(Bootstrapped)}.jar")
       },
+      mimaPreviousArtifacts +=
+        ("org.scala-lang" % "scala-library" % stdlibVersion(Bootstrapped)),
+      mimaCheckDirection := "backward",
+      mimaExcludeAnnotations ++= Seq(
+        "scala.annotation.experimental",
+        "scala.annotation.specialized",
+        "scala.annotation.unspecialized",
+        ),
+      mimaBinaryIssueFilters ++= MiMaFilters.LibraryBootstrapped,
       run := {
         val args: Seq[String] = spaceDelimited("<arg>").parsed
         val reference = (Compile/sourceManaged).value / "scala-library-src"

project/MiMaFilters.scala

@@ -49,4 +49,128 @@ object MiMaFilters {
     ProblemFilters.exclude[DirectMissingMethodProblem]("dotty.tools.dotc.interfaces.Diagnostic.diagnosticRelatedInformation"),
     ProblemFilters.exclude[MissingClassProblem]("dotty.tools.dotc.interfaces.DiagnosticRelatedInformation")
   )
+
+  val LibraryBootstrapped: Seq[ProblemFilter] = Seq(
+    // Files that are not compiled in the bootstrapped library
+    ProblemFilters.exclude[MissingClassProblem]("scala.AnyVal"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.Unit.this"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.Boolean.this"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.Byte.this"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.Short.this"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.Int.this"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.Long.this"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.Float.this"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.Double.this"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.Char.this"),
+
+
+    // Scala language features
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.language.<clinit>"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.language#experimental.<clinit>"),
+    ProblemFilters.exclude[FinalClassProblem]("scala.language$experimental$"),
+    ProblemFilters.exclude[FinalClassProblem]("scala.languageFeature$*$"),
+
+    // trait $init$
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.*.$init$"),
+
+    // Case class unapply
+    ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.*.unapply"),
+
+    // Value class extension methods
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.*$extension"),
+    ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.*$extension"),
+
+    // Companion module class
+    ProblemFilters.exclude[FinalClassProblem]("scala.*$"),
+    ProblemFilters.exclude[MissingTypesProblem]("scala.*$"),
+
+    // Tuples
+    ProblemFilters.exclude[FinalClassProblem]("scala.Tuple1"),
+    ProblemFilters.exclude[FinalClassProblem]("scala.Tuple2"),
+    ProblemFilters.exclude[MissingFieldProblem]("scala.Tuple*._*"), // Tuple1._1, Tuple2._1, Tuple2._2
+
+    // Scala 2 intrinsic macros
+    ProblemFilters.exclude[FinalMethodProblem]("scala.StringContext.s"),
+
+    // scala.math.Ordering.tryCompare
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.*.tryCompare"),
+
+    // Scala 2 specialization
+    ProblemFilters.exclude[MissingClassProblem]("scala.*$sp"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.*$sp"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.*#*#sp.$init$"),
+    ProblemFilters.exclude[MissingTypesProblem]("scala.collection.DoubleStepper"),
+    ProblemFilters.exclude[MissingTypesProblem]("scala.collection.immutable.DoubleVectorStepper"),
+    ProblemFilters.exclude[MissingTypesProblem]("scala.collection.immutable.IntVectorStepper"),
+    ProblemFilters.exclude[MissingTypesProblem]("scala.collection.immutable.LongVectorStepper"),
+    ProblemFilters.exclude[MissingTypesProblem]("scala.collection.IntStepper"),
+    ProblemFilters.exclude[MissingTypesProblem]("scala.collection.LongStepper"),
+    ProblemFilters.exclude[MissingTypesProblem]("scala.jdk.DoubleAccumulator"),
+    ProblemFilters.exclude[MissingTypesProblem]("scala.jdk.FunctionWrappers$*"),
+    ProblemFilters.exclude[MissingTypesProblem]("scala.jdk.IntAccumulator"),
+    ProblemFilters.exclude[MissingTypesProblem]("scala.jdk.LongAccumulator"),
+
+    // non-categorized
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.convert.JavaCollectionWrappers#*.iterableFactory"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.convert.JavaCollectionWrappers#*.mapFactory"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.convert.JavaCollectionWrappers#IteratorWrapper.remove"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.immutable.ArraySeq#*.elemTag"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.immutable.BitSet.bitSetFactory"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.immutable.HashCollisionSetNode.copy"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.immutable.MapKeyValueTupleHashIterator.next"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.immutable.TreeSet.sortedIterableFactory"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.LinearSeqIterator#LazyCell.this"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.mutable.AnyRefMap#ToBuildFrom.newBuilder"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.mutable.ArraySeq#*.elemTag"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.mutable.BitSet.bitSetFactory"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.mutable.LinkedHashMap.newBuilder"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.mutable.LinkedHashSet.newBuilder"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.mutable.LongMap#ToBuildFrom.newBuilder"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.mutable.PriorityQueue#ResizableArrayAccess.this"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.mutable.TreeMap.sortedMapFactory"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.StringView.andThen"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.StringView.compose"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.collection.View#*.iterator"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.concurrent.BatchingExecutor#AbstractBatch.this"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.concurrent.Channel#LinkedList.this"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.concurrent.duration.Deadline.apply"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.concurrent.duration.Deadline.copy"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.concurrent.duration.Deadline.copy$default$1"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.concurrent.duration.FiniteDuration.unary_-"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.Enumeration#ValueOrdering.this"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.io.Source#RelaxedPosition.this"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.math.BigDecimal.underlying"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.PartialFunction#OrElse.andThen"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.PartialFunction#OrElse.orElse"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.runtime.Rich*.num"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.runtime.Rich*.ord"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.ScalaReflectionException.andThen"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.ScalaReflectionException.compose"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.UninitializedFieldError.andThen"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.UninitializedFieldError.compose"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.util.Properties.<clinit>"),
+    ProblemFilters.exclude[DirectMissingMethodProblem]("scala.util.Sorting.scala$util$Sorting$$mergeSort$default$5"),
+    ProblemFilters.exclude[FinalClassProblem]("scala.collection.ArrayOps$ReverseIterator"),
+    ProblemFilters.exclude[FinalMethodProblem]("scala.Enumeration.ValueOrdering"),
+    ProblemFilters.exclude[FinalMethodProblem]("scala.Enumeration.ValueSet"),
+    ProblemFilters.exclude[FinalMethodProblem]("scala.io.Source.NoPositioner"),
+    ProblemFilters.exclude[FinalMethodProblem]("scala.io.Source.RelaxedPosition"),
+    ProblemFilters.exclude[FinalMethodProblem]("scala.io.Source.RelaxedPositioner"),
+    ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.collection.convert.JavaCollectionWrappers#*.empty"),
+    ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.collection.immutable.RedBlackTree#EqualsIterator.nextResult"),
+    ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.collection.immutable.SortedMapOps.coll"),
+    ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.collection.immutable.TreeMap.empty"),
+    ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.collection.immutable.TreeMap.fromSpecific"),
+    ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.collection.mutable.ArrayBuilder#ofUnit.addAll"),
+    ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.collection.mutable.LinkedHashMap.newBuilder"),
+    ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.collection.mutable.LinkedHashSet.newBuilder"),
+    ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.collection.mutable.TreeMap.empty"),
+    ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.collection.mutable.TreeMap.fromSpecific"),
+    ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.reflect.ManifestFactory#NothingManifest.newArray"),
+    ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.reflect.ManifestFactory#NullManifest.newArray"),
+    ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.StringContext.unapplySeq"),
+    ProblemFilters.exclude[MissingFieldProblem]("scala.collection.ArrayOps#ReverseIterator.xs"),
+    ProblemFilters.exclude[MissingFieldProblem]("scala.runtime.NonLocalReturnControl.value"),
+    ProblemFilters.exclude[ReversedMissingMethodProblem]("scala.collection.immutable.SortedMapOps.coll"),
+  )
 }

stdlib-bootstrapped/README.md

@@ -11,3 +11,7 @@ To clone or list non-overridden sources execute `stdlib-bootstrapped/run`.
 
 This project generates a version of the Scala 3 library that contains the full library with
 TASTy files. The compiled library is located in `out/bootstrap/stdlib-bootstrapped/`.
+
+MiMa checks (`stdlib-bootstrapped/mimaReportBinaryIssues`) will check the backwards binary
+compatibility compared with `"org.scala-lang" % "scala-library" % stdlibVersion(Bootstrapped)`.
+MiMa filter are located in `project/MiMaFilters.scala`.