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

Kotlin · Dec 4, 2024 · 8b8a0f8 · 8b8a0f8
1 parent 6c6df2b
commit 8b8a0f8
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 2 deletions.
diff --git a/kotlinx-coroutines-core/jvm/src/Exceptions.kt b/kotlinx-coroutines-core/jvm/src/Exceptions.kt
@@ -61,6 +61,6 @@ 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 */
+        (message!!.hashCode() * 31 + (job?.hashCode() ?: 0)) * 31 + (cause?.hashCode() ?: 0)
 }
diff --git a/kotlinx-coroutines-core/jvm/test/JobCancellationExceptionSerializerTest.kt b/kotlinx-coroutines-core/jvm/test/JobCancellationExceptionSerializerTest.kt
@@ -36,4 +36,31 @@ class JobCancellationExceptionSerializerTest : TestBase() {
             finish(4)
         }
     }
+
+    @Test
+    fun testHashCodeAfterDeserialization() = runTest {
+        try {
+            coroutineScope {
+                val job = launch {
+                    hang {}
+                }
+                throw JobCancellationException(
+                    message = "Job Cancelled",
+                    job = job,
+                    cause = null,
+                )
+            }
+        } catch (e: Throwable) {
+            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)
+        }
+    }
 }