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

Support serializing asJavaIterable. #192

Merged
merged 2 commits into from
Jul 2, 2014
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
package com.twitter.chill

import _root_.java.lang.{ Iterable => JIterable }

/**
* A Kryo serializer for serializing results returned by asJavaIterable.
*
* The underlying object is scala.collection.convert.Wrappers$IterableWrapper.
* Kryo deserializes this into an AbstractCollection, which unfortunately doesn't work.
*
* Ported from Apache Spark's KryoSerializer.scala.
*/
private class JavaIterableWrapperSerializer extends KSerializer[JIterable[_]] {

import JavaIterableWrapperSerializer._

override def write(kryo: Kryo, out: Output, obj: JIterable[_]): Unit = {
// If the object is the wrapper, simply serialize the underlying Scala Iterable object.
// Otherwise, serialize the object itself.
if (obj.getClass == wrapperClass && underlyingMethodOpt.isDefined) {
kryo.writeClassAndObject(out, underlyingMethodOpt.get.invoke(obj))
} else {
kryo.writeClassAndObject(out, obj)
}
}

override def read(kryo: Kryo, in: Input, clz: Class[JIterable[_]]): JIterable[_] = {
kryo.readClassAndObject(in) match {
case scalaIterable: Iterable[_] =>
scala.collection.JavaConversions.asJavaIterable(scalaIterable)
case javaIterable: JIterable[_] =>
javaIterable
}
}
}

private object JavaIterableWrapperSerializer {
// The class returned by asJavaIterable (scala.collection.convert.Wrappers$IterableWrapper).
val wrapperClass = scala.collection.JavaConversions.asJavaIterable(Seq(1)).getClass

// Get the underlying method so we can use it to get the Scala collection for serialization.
private val underlyingMethodOpt = {
try Some(wrapperClass.getDeclaredMethod("underlying")) catch {
case e: Exception =>
None
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -163,11 +163,21 @@ class ScalaCollectionsRegistrar extends IKryoRegistrar {
}
}

class JavaWrapperCollectionRegistrar extends IKryoRegistrar {
def apply(newK: Kryo) {
newK.register(JavaIterableWrapperSerializer.wrapperClass, new JavaIterableWrapperSerializer)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should this maybe be split out as a separate class from the normal collections -- I presume eventually we may want all the collections wrappers?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess that's a decision for the project lead(s) ...

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ok then, lets do that so. Split out the wrappers from the core collections.

}
}

/** Registers all the scala (and java) serializers we have */
class AllScalaRegistrar extends IKryoRegistrar {
def apply(k: Kryo) {
val col = new ScalaCollectionsRegistrar
col(k)

val jcol = new JavaWrapperCollectionRegistrar
jcol(k)

// Register all 22 tuple serializers and specialized serializers
ScalaTupleSerialization.register(k)
k.forClass[Symbol](new KSerializer[Symbol] {
Expand Down
4 changes: 4 additions & 0 deletions chill-scala/src/test/scala/com/twitter/chill/KryoSpec.scala
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,10 @@ class KryoSpec extends Specification with BaseProperties {
"handle scala enums" in {
WeekDay.values.foreach { _ must roundtrip }
}
"handle asJavaIterable" in {
val col = scala.collection.JavaConversions.asJavaIterable(Seq(12345))
col must roundtrip
}
"use java serialization" in {
val kinst = { () => getKryo.javaForClass[TestCaseClassForSerialization] }
rtEquiv(kinst, TestCaseClassForSerialization("hey", 42)) must beTrue
Expand Down