Skip to content

Ensure custom KProperty include the name in the hashcode #1710

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import kotlin.reflect.jvm.javaField
import org.bson.codecs.pojo.annotations.BsonId
import org.bson.codecs.pojo.annotations.BsonProperty

private val pathCache: MutableMap<String, String> by lazySoft { ConcurrentHashMap<String, String>() }
private val pathCache: MutableMap<Int, String> by lazySoft { ConcurrentHashMap<Int, String>() }

/** Returns a composed property. For example Friend::address / Address::postalCode = "address.postalCode". */
public operator fun <T0, T1, T2> KProperty1<T0, T1?>.div(p2: KProperty1<T1, T2?>): KProperty1<T0, T2?> =
Expand Down Expand Up @@ -71,8 +71,7 @@ public fun <T> KProperty<T>.path(): String {
return if (this is KPropertyPath<*, T>) {
this.name
} else {
pathCache.computeIfAbsent(this.toString()) {

pathCache.computeIfAbsent(hashCode()) {
// Check serial name - Note kotlinx.serialization.SerialName may not be on the class
// path
val serialName =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ package com.mongodb.kotlin.client.property

import com.mongodb.annotations.Sealed
import com.mongodb.kotlin.client.model.path
import java.util.Objects
import kotlin.reflect.KParameter
import kotlin.reflect.KProperty1
import kotlin.reflect.KType
Expand Down Expand Up @@ -84,6 +85,15 @@ public open class KPropertyPath<T, R>(
override fun callBy(args: Map<KParameter, Any?>): R = unSupportedOperation()
override fun get(receiver: T): R = unSupportedOperation()
override fun getDelegate(receiver: T): Any? = unSupportedOperation()
override fun hashCode(): Int = Objects.hash(previous, property, name)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a good idea to provide the hashCode and equals but these weren't involved in the code path since we return the name directly if the instance is KPropertyPath in

return if (this is KPropertyPath<*, T>) {
        this.name

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not used for the direct path, but the hashcode for CustomProperty relies on the hashcode.

override fun equals(other: Any?): Boolean {
if (this === other) return true
if (javaClass != other?.javaClass) return false
other as KPropertyPath<*, *>
return Objects.equals(previous, other.previous) &&
Objects.equals(property, other.property) &&
Objects.equals(name, other.name)
}

public companion object {

Expand Down Expand Up @@ -121,6 +131,13 @@ public open class KPropertyPath<T, R>(
override fun get(receiver: T): R = unSupportedOperation()
override fun getDelegate(receiver: T): Any? = unSupportedOperation()
override fun invoke(p1: T): R = unSupportedOperation()
override fun hashCode(): Int = Objects.hash(previous, name)
override fun equals(other: Any?): Boolean {
if (this === other) return true
if (javaClass != other?.javaClass) return false
other as CustomProperty<*, *>
return Objects.equals(previous, other.previous) && Objects.equals(name, other.name)
}
}

/** Provides "fake" property with custom name. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,4 +139,20 @@ class KPropertiesTest {
assertThrows<UnsupportedOperationException> { property.get(restaurant) }
assertThrows<UnsupportedOperationException> { property.getDelegate(restaurant) }
}

@Test
fun testNoCacheCollisions() {
for (i in 1.rangeTo(25_000)) {
assertEquals("reviews.$i", Restaurant::reviews.pos(i).path())
assertEquals("reviews.$[identifier$i]", Restaurant::reviews.filteredPosOp("identifier$i").path())
assertEquals("localeMap.$i", Restaurant::localeMap.keyProjection(i).path())

val x = i / 2
assertEquals(
"reviews.$[identifier$x].rating",
(Restaurant::reviews.filteredPosOp("identifier$x") / Review::score).path())
assertEquals("reviews.$x.rating", (Restaurant::reviews.pos(x) / Review::score).path())
assertEquals("localeMap.$x.rating", (Restaurant::localeMap.keyProjection(x) / Review::score).path())
}
}
}