Should Cookies's equality be based on its inner Cookies?

[y-yu]

• It's inconvenient for mocking like:

  val fakeCookies = Cookies(Nil)
  
  Mockito.when(userIdFromCookieService.get(fakeCookies))
     .thenReturn(UserId("foobar"))

• So would it be better to determine if two Cookies are the same or not based on its contents? 🤔

Play Version

2.8.19

API

play.api.mvc.Cookies

Operating System

• macOS

JDK

• OpenJDK 64-Bit Server VM, Java 11.0.18

Actual Behavior

scala> play.api.mvc.Cookies.apply(Nil)
val res0: play.api.mvc.Cookies = Iterable()

scala> play.api.mvc.Cookies.apply(Nil)
val res1: play.api.mvc.Cookies = Iterable()

scala> res0 == res1
val res2: Boolean = false

Expected Behavior

res0 == res1 // true

P.S.

In Mokito, here is a work around:

def eqCookies(expected: Cookies): Cookies = {
  val matcher: ArgumentMatcher[Cookies] = (argument: Cookies) => {
    (argument == null && expected == null) ||
    (argument != null && expected != null && argument.toSeq == expected.toSeq)
  }
  ThreadSafeMockingProgress
    .mockingProgress()
    .getArgumentMatcherStorage
    .reportMatcher(matcher)
  null
}

val fakeCookies = Cookies(Nil)

Mockito.when(userIdFromCookieService.get(eqCookies(fakeCookies)))
   .thenReturn(UserId("foobar"))