Full document serialization

[clementetb]

Full document serialization enables using any class as argument and return types to:

• Custom function credentials
• Atlas function calls
• User profile and custom data

It uses the new experimental EJson decoder available in Kbson. The decoder is based on kserializer and there are some considerations to have into account.

1. It is an experimental feature and it is subject to change.

2. Custom function credentials are late evaluated when the instance is actually used. This is required because the payload encoding requires access to the EJson instance defined in the App configuration, but because Credentials are decoupled from the App we only can have access to the App instance when the Credentials are actually being used.

3. Atlas function calls now use a Builder pattern. This is required because kserializer does not support runtime serializer lookup, which we are required to do in compile time.

4. Values must be @Serializable or a custom serializer must be specified on call.

Examples

Credentials

Crendetials.customFunction(
   Payload(
       name = "hello",
       id = 400
   )
)

User profile and custom Data

val profile: MyCustomProfile = user.profile()

val customData: MyCustomData = user.customData()

Function call

val dog: Dog = user.functions.call("findDog") {
    add(Owner(name = "Luis"))
    add("Golden retriever")
}

Pending

• Changelog
• Examples
• Update to KBson 0.3.0

closes #994

[rorbech]

I am a bit confused about the @OptIns, but maybe I am just missing some pieces. Just to clarify before going into details:

• I would expect that you can still use the current API without opt'ing in to anything and that it is only new stuff that requires opt'ing in, right? And
• Are the any need for an API surface that requires users to opt into KBson's ExperimentalKSerializerApi without also wanting to use our ExperimentalRealmSerializerApi?

[cmelchior]

Looking good. Minor comments and awaiting final approval until CI is green.

[cmelchior]

Awesome 🚀