Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make hashing childrenOfSealedClass stable #788

Merged
merged 1 commit into from
May 28, 2020
Merged

Make hashing childrenOfSealedClass stable #788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion internal/zinc-apiinfo/src/main/scala/xsbt/api/HashAPI.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ final class HashAPI private (
hashTypeParameters(c.typeParameters)
hashType(c.selfType)
if (includeSealedChildren)
hashTypes(c.childrenOfSealedClass, includeDefinitions)
hashTypesSymmetric(c.childrenOfSealedClass, includeDefinitions)
dwijnand marked this conversation as resolved.
Show resolved Hide resolved

val isTrait = c.definitionType() == DefinitionType.Trait
hashStructure(c.structure, includeDefinitions, isTrait)
Expand Down Expand Up @@ -341,6 +341,8 @@ final class HashAPI private (

def hashTypes(ts: Array[Type], includeDefinitions: Boolean = true) =
hashArray(ts, (t: Type) => hashType(t, includeDefinitions))
def hashTypesSymmetric(ts: Array[Type], includeDefinitions: Boolean = true) =
hashSymmetric(ts, hashType(_, includeDefinitions))
def hashType(t: Type, includeDefinitions: Boolean = true): Unit =
t match {
case s: Structure => hashStructure(s, includeDefinitions, false)
Expand Down
30 changes: 20 additions & 10 deletions internal/zinc-apiinfo/src/test/scala/xsbt/api/HashAPISpecification.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,14 @@

package xsbt.api

import xsbti.api.{ ClassLike, Def, DefinitionType, Var, Modifiers, TypeDeclaration, TypeAlias }
import xsbti.api._
import sbt.internal.inc.UnitSpec
import xsbt.api.ClassLikeHelpers._

class HashAPISpecification extends UnitSpec {
"The HashAPI specification" should "detect hash changes in private trait vars" in {
behavior of "The HashAPI specification"

it should "detect hash changes in private trait vars" in {
val privateVar = Var.of("x", privateAccess, defaultMods, Array.empty, emptyType)
val tWithPrivateMember = simpleTrait("Foo", List(privateVar))
val tWithNothing = simpleTrait("Foo", Nil)
Expand Down Expand Up @@ -85,18 +87,26 @@ class HashAPISpecification extends UnitSpec {
assertDifferentPrivateAPI(tWithPrivateMember, tWithNothing)
}

it should "not detect hash changes in childrenOfSealedClass ordering" in {
val t = Projection.of(emptyType, "t")
val f = Projection.of(emptyType, "f")
val b = simpleTrait("Bool", Nil)
val x = b.withChildrenOfSealedClass(Array(f, t))
val y = b.withChildrenOfSealedClass(Array(t, f))
assertSamePrivateAPI(x, y) // was "-188164889 did not equal 992093599"
}

def assertDifferentPrivateAPI(a: ClassLike, b: ClassLike): Unit = assertPrivateApi(true, a, b)
def assertSamePrivateAPI(a: ClassLike, b: ClassLike): Unit = assertPrivateApi(false, a, b)
def assertPrivateApi(isDifferent: Boolean, a: ClassLike, b: ClassLike): Unit = {
def hashWithPrivate(c: ClassLike): Int =
HashAPI.apply(_.hashAPI(c), includePrivateDefsInTrait = true)

def PrivateAPI(c: ClassLike): Int = HashAPI(_.hashAPI(c), includePrivateDefsInTrait = true)
def checkOrder(a: ClassLike, b: ClassLike): Unit = {
// Check the the default Same API doesn't take private methods into account
assert(HashAPI.apply(a) == HashAPI.apply(b), s"HashAPI(${a}) != HashAPI(${b})")
val samePrivateHash = hashWithPrivate(a) == hashWithPrivate(b)
if (isDifferent) assert(!samePrivateHash, s"PrivateAPI(${a}) == PrivateAPI(${b})")
else assert(samePrivateHash, s"PrivateAPI(${a}) != PrivateAPI(${b})")
// Check the default Hash API doesn't take private methods into account
assert(HashAPI(a) == HashAPI(b), s"HashAPI(${a}) != HashAPI(${b})")
if (isDifferent)
assert(PrivateAPI(a) != PrivateAPI(b), s"PrivateAPI(${a}) == PrivateAPI(${b})")
else
assert(PrivateAPI(a) == PrivateAPI(b), s"PrivateAPI(${a}) != PrivateAPI(${b})")
()
}

Expand Down