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.

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

fix(jvm): make job cancellation hashcode not fail after deserialization #4291

Merged
Merged
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
8 changes: 6 additions & 2 deletions kotlinx-coroutines-core/jvm/src/Exceptions.kt
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ internal actual class JobCancellationException public actual constructor(
override fun equals(other: Any?): Boolean =
other === this ||
other is JobCancellationException && other.message == message && other.job == job && other.cause == cause
override fun hashCode(): Int =
(message!!.hashCode() * 31 + job.hashCode()) * 31 + (cause?.hashCode() ?: 0)

override fun hashCode(): Int {
// since job is transient it is indeed nullable after deserialization
@Suppress("UNNECESSARY_SAFE_CALL")
return (message!!.hashCode() * 31 + (job?.hashCode() ?: 0)) * 31 + (cause?.hashCode() ?: 0)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,30 @@ class JobCancellationExceptionSerializerTest : TestBase() {
finish(4)
}
}

@Test
fun testHashCodeAfterDeserialization() = runTest {
try {
coroutineScope {
expect(1)
throw JobCancellationException(
message = "Job Cancelled",
job = Job(),
cause = null,
)
}
} catch (e: Throwable) {
finish(2)
val outputStream = ByteArrayOutputStream()
ObjectOutputStream(outputStream).use {
it.writeObject(e)
}
val deserializedException =
ObjectInputStream(outputStream.toByteArray().inputStream()).use {
it.readObject() as JobCancellationException
}
// verify hashCode does not fail even though Job is transient
assert(deserializedException.hashCode() != 0)
}
}
}