arangodb / java-velocypack-module-scala Goto Github PK

License: Apache License 2.0

Scala 100.00%

java-velocypack-module-scala's Introduction

[DEPRECATED]: `velocypack-module-scala` has been deprecated.

Please consider using jackson-dataformat-velocypack instead. For usage in the ArangoDB Java driver, refer to the official serialization documentation.

ArangoDB VelocyPack Java Module Scala

Scala module for Java VelocyPack.

Added support for:

scala.Option
scala.collection.immutable.List
scala.collection.immutable.Map
scala.math.BigInt
scala.math.BigDecimal

Maven

To add the dependency to your project with maven, add the following code to your pom.xml:

<!-- Scala 2.11 -->
<dependency>
    <groupId>com.arangodb</groupId>
    <artifactId>velocypack-module-scala_2.11</artifactId>
    <version>1.2.0</version>
</dependency>

        <!-- Scala 2.12 -->
<dependency>
<groupId>com.arangodb</groupId>
<artifactId>velocypack-module-scala_2.12</artifactId>
<version>1.2.0</version>
</dependency>

Compile

mvn clean install

Usage / registering module

val vpack: VPack = new VPack.Builder().registerModule(new VPackScalaModule).build

Learn more

java-velocypack-module-scala's People

Contributors

Stargazers

Watchers

Forkers

gbicou wajda dacr

java-velocypack-module-scala's Issues

MapLike serialized incorrectly

Maps obtained by calling Map.mapValues(...) or Map.filterKeys(...) etc serialized as plain objects ({f: {}} and {p: {}} respectively)

Nested collections support

E.g. Seq[Seq[1, 2, 3]] is serialized as [{"head":1,"tl":[2,3]}] instead of expected [[1, 2, 3]]

Support for scala.collection.Seq

velocypack-module-scala:1.0.4 doesn't support Scala ser/deserialization for Seq

Currently velocypack-module-scala only supports immutable Map up to the size of 4.
Basically only the types EmptyMap, Map1, Map2, Map3 and Map4 are serialized correctly.
Other maps (e.g. HashMap, TrieMap, TreeMap, ListMap etc) aren't supported.

Cross-compilation for Scala 2.11 and 2.12

Currently velocypack-module-scala is only compiled against Scala 2.11, that makes it impossible to use it with higher Scala version.

StackOverflowError when serializing Scala enum

object TestEnum extends Enumeration {
  type TestEnum = Value
  val Foo: TestEnum = Value("foo")
  val Bar: TestEnum = Value("bar")
}

new VPack.Builder()
  .registerModule(new VPackScalaModule)
  .build()
  .serialize(TestEnum.Foo)

produces

java.lang.StackOverflowError
	at java.util.ArrayList.grow(ArrayList.java:260)
	at java.util.ArrayList.ensureExplicitCapacity(ArrayList.java:241)
	at java.util.ArrayList.ensureCapacityInternal(ArrayList.java:233)
	at java.util.ArrayList.add(ArrayList.java:464)
	at com.arangodb.velocypack.VPackBuilder.reportAdd(VPackBuilder.java:872)
	at com.arangodb.velocypack.VPackBuilder.addInternal(VPackBuilder.java:647)
	at com.arangodb.velocypack.VPackBuilder.addInternal(VPackBuilder.java:632)
	at com.arangodb.velocypack.VPackBuilder.add(VPackBuilder.java:413)
	at com.arangodb.velocypack.internal.VPackSerializers$1.serialize(VPackSerializers.java:55)
	at com.arangodb.velocypack.internal.VPackSerializers$1.serialize(VPackSerializers.java:48)
	at com.arangodb.velocypack.VPack.addValue(VPack.java:858)
	at com.arangodb.velocypack.VPack.serializeField(VPack.java:839)
	at com.arangodb.velocypack.VPack.serializeFields(VPack.java:816)
	at com.arangodb.velocypack.VPack.serializeObject(VPack.java:803)
	at com.arangodb.velocypack.VPack.addValue(VPack.java:882)
	at com.arangodb.velocypack.VPack.addValue(VPack.java:879)
	at com.arangodb.velocypack.VPack.serializeField(VPack.java:839)
	at com.arangodb.velocypack.VPack.serializeFields(VPack.java:816)
	at com.arangodb.velocypack.VPack.serializeObject(VPack.java:803)
	at com.arangodb.velocypack.VPack.addValue(VPack.java:882)
	at com.arangodb.velocypack.VPack.addValue(VPack.java:879)
	at com.arangodb.velocypack.VPack.serializeField(VPack.java:839)
	at com.arangodb.velocypack.VPack.serializeFields(VPack.java:816)
	at com.arangodb.velocypack.VPack.serializeObject(VPack.java:803)
	at com.arangodb.velocypack.VPack.addValue(VPack.java:882)
	at com.arangodb.velocypack.VPack.addValue(VPack.java:879)
	at com.arangodb.velocypack.VPack.serializeField(VPack.java:839)
	at com.arangodb.velocypack.VPack.serializeFields(VPack.java:816)
	at com.arangodb.velocypack.VPack.serializeObject(VPack.java:803)
	at com.arangodb.velocypack.VPack.addValue(VPack.java:882)
	at com.arangodb.velocypack.VPack.addValue(VPack.java:879)
	at com.arangodb.velocypack.VPack.serializeField(VPack.java:839)
	at com.arangodb.velocypack.VPack.serializeFields(VPack.java:816)
	at com.arangodb.velocypack.VPack.serializeObject(VPack.java:803)
	at com.arangodb.velocypack.VPack.addValue(VPack.java:882)
	at com.arangodb.velocypack.VPack.addValue(VPack.java:879)
	at com.arangodb.velocypack.VPack.serializeField(VPack.java:839)
	at com.arangodb.velocypack.VPack.serializeFields(VPack.java:816)
	at com.arangodb.velocypack.VPack.serializeObject(VPack.java:803)
	at com.arangodb.velocypack.VPack.addValue(VPack.java:882)
        ...

Option deserialization does not operate according to expectations

According to VPackScalaDeserializers :

  val OPTION = new VPackDeserializerParameterizedType[Option[Any]] {
    ...
    ...
    ...
    def deserialize(parent: VPackSlice, vpack: VPackSlice, context: VPackDeserializationContext, t: ParameterizedType): Option[Any] = {
      val value = context.deserialize(vpack, t.getActualTypeArguments()(0).asInstanceOf[Class[Any]])
      value match {
        case null => None
        case _    => Some(value)
      }
    }
  }

However, it seems null are ignored during deserialization, so this method never executes, resulting in null where None was expected