Adapter singleton and instance adapter discoverability for RealmInstant

Author: clementetb

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/Configuration.kt

@@ -25,6 +25,7 @@ import io.realm.kotlin.log.LogLevel
 import io.realm.kotlin.log.RealmLog
 import io.realm.kotlin.log.RealmLogger
 import io.realm.kotlin.types.BaseRealmObject
+import io.realm.kotlin.types.RealmTypeAdapter
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlin.reflect.KClass
 
@@ -238,6 +239,7 @@ public interface Configuration {
         protected var initialDataCallback: InitialDataCallback? = null
         protected var inMemory: Boolean = false
         protected var initialRealmFileConfiguration: InitialRealmFileConfiguration? = null
+        protected var typeAdapters: List<RealmTypeAdapter<*, *>> = listOf()
 
         /**
          * Sets the filename of the realm file.

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/RealmConfiguration.kt

@@ -24,6 +24,7 @@ import io.realm.kotlin.log.RealmLog
 import io.realm.kotlin.log.RealmLogger
 import io.realm.kotlin.migration.AutomaticSchemaMigration
 import io.realm.kotlin.migration.RealmMigration
+import io.realm.kotlin.types.RealmTypeAdapter
 import io.realm.kotlin.types.TypedRealmObject
 import kotlin.reflect.KClass
 
@@ -89,6 +90,19 @@ public interface RealmConfiguration : Configuration {
         public fun directory(directoryPath: String): Builder =
             apply { this.directory = directoryPath }
 
+        // TODO misplaced, move around
+        public class TypeAdapterBuilder {
+            internal val adapters: MutableList<RealmTypeAdapter<*, *>> = mutableListOf()
+            public fun add(adapter: RealmTypeAdapter<*,*>) {
+                adapters.add(adapter)
+            }
+        }
+
+        public fun typeAdapters(block: TypeAdapterBuilder.()->Unit): Builder =
+            apply {
+                this.typeAdapters = TypeAdapterBuilder().apply(block).adapters
+            }
+
         /**
          * Setting this will change the behavior of how migration exceptions are handled. Instead of
          * throwing an exception the on-disc Realm will be cleared and recreated with the new Realm
@@ -192,7 +206,8 @@ public interface RealmConfiguration : Configuration {
                 initialDataCallback,
                 inMemory,
                 initialRealmFileConfiguration,
-                realmLogger
+                realmLogger,
+                typeAdapters,
             )
         }
     }

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/internal/ConfigurationImpl.kt

@@ -45,6 +45,7 @@ import io.realm.kotlin.internal.util.CoroutineDispatcherFactory
 import io.realm.kotlin.migration.AutomaticSchemaMigration
 import io.realm.kotlin.migration.RealmMigration
 import io.realm.kotlin.types.BaseRealmObject
+import io.realm.kotlin.types.RealmTypeAdapter
 import kotlin.reflect.KClass
 
 // TODO Public due to being accessed from `library-sync`
@@ -67,7 +68,8 @@ public open class ConfigurationImpl(
     override val isFlexibleSyncConfiguration: Boolean,
     inMemory: Boolean,
     initialRealmFileConfiguration: InitialRealmFileConfiguration?,
-    logger: ContextLogger
+    logger: ContextLogger,
+    override val adapters: List<RealmTypeAdapter<*, *>>,
 ) : InternalConfiguration {
 
     override val path: String

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/internal/Converters.kt

@@ -36,6 +36,7 @@ import io.realm.kotlin.types.ObjectId
 import io.realm.kotlin.types.RealmAny
 import io.realm.kotlin.types.RealmInstant
 import io.realm.kotlin.types.RealmObject
+import io.realm.kotlin.types.RealmTypeAdapter
 import io.realm.kotlin.types.RealmUUID
 import io.realm.kotlin.types.geo.GeoBox
 import io.realm.kotlin.types.geo.GeoCircle
@@ -259,6 +260,32 @@ internal object IntConverter : CoreIntConverter, CompositeConverter<Int, Long>()
 public inline fun intToLong(value: Int?): Long? = value?.toLong()
 public inline fun longToInt(value: Long?): Int? = value?.toInt()
 
+public inline fun toRealm(
+    obj: RealmObjectReference<out BaseRealmObject>,
+    converterClass: KClass<RealmTypeAdapter<Any, Any>>,
+    userValue: Any,
+): Any {
+    val adapter = obj.owner.owner
+        .configuration
+        .adapters
+        .first { it::class == converterClass } as RealmTypeAdapter<Any, Any>
+
+    return adapter.toRealm(userValue)
+}
+
+public inline fun fromRealm(
+    obj: RealmObjectReference<out BaseRealmObject>,
+    converterClass: KClass<RealmTypeAdapter<*, *>>,
+    realmValue: Any,
+): Any {
+    val adapter = obj.owner.owner
+        .configuration
+        .adapters
+        .first { it::class == converterClass } as RealmTypeAdapter<Any, Any>
+
+    return adapter.fromRealm(realmValue)
+}
+
 internal object RealmInstantConverter : PassThroughPublicConverter<RealmInstant>() {
     override inline fun fromRealmValue(realmValue: RealmValue): RealmInstant? =
         if (realmValue.isNull()) null else realmValueToRealmInstant(realmValue)

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/internal/InternalConfiguration.kt

@@ -21,6 +21,7 @@ import io.realm.kotlin.internal.interop.RealmConfigurationPointer
 import io.realm.kotlin.internal.interop.SchemaMode
 import io.realm.kotlin.internal.util.CoroutineDispatcherFactory
 import io.realm.kotlin.types.BaseRealmObject
+import io.realm.kotlin.types.RealmTypeAdapter
 import kotlin.reflect.KClass
 
 /**
@@ -36,6 +37,7 @@ public interface InternalConfiguration : Configuration {
     public val writeDispatcherFactory: CoroutineDispatcherFactory
     public val schemaMode: SchemaMode
     public val logger: ContextLogger
+    public val adapters: List<RealmTypeAdapter<*, *>>
 
     // Temporary work-around for https://github.com/realm/realm-kotlin/issues/724
     public val isFlexibleSyncConfiguration: Boolean

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/internal/RealmConfigurationImpl.kt

@@ -25,6 +25,7 @@ import io.realm.kotlin.internal.interop.SchemaMode
 import io.realm.kotlin.internal.util.CoroutineDispatcherFactory
 import io.realm.kotlin.migration.RealmMigration
 import io.realm.kotlin.types.BaseRealmObject
+import io.realm.kotlin.types.RealmTypeAdapter
 import kotlin.reflect.KClass
 
 public const val REALM_FILE_EXTENSION: String = ".realm"
@@ -47,7 +48,8 @@ internal class RealmConfigurationImpl(
     initialDataCallback: InitialDataCallback?,
     inMemory: Boolean,
     override val initialRealmFileConfiguration: InitialRealmFileConfiguration?,
-    logger: ContextLogger
+    logger: ContextLogger,
+    adapters: List<RealmTypeAdapter<*, *>>
 ) : ConfigurationImpl(
     directory,
     name,
@@ -69,6 +71,7 @@ internal class RealmConfigurationImpl(
     false,
     inMemory,
     initialRealmFileConfiguration,
-    logger
+    logger,
+    adapters,
 ),
     RealmConfiguration

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/types/RealmTypeAdapter.kt

@@ -0,0 +1,14 @@
+package io.realm.kotlin.types
+
+/**
+ * TODO
+ *
+ * @param R realm type.
+ * @param U user type.
+ */
+public interface RealmTypeAdapter<R, U> { // where P is a supported realm type
+
+    public fun fromRealm(realmValue: R): U
+
+    public fun toRealm(value: U): R
+}

packages/library-base/src/commonMain/kotlin/io/realm/kotlin/types/annotations/TypeAdapter.kt

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2022 Realm Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.realm.kotlin.types.annotations
+
+import io.realm.kotlin.types.RealmTypeAdapter
+import kotlin.reflect.KClass
+
+@Retention(AnnotationRetention.SOURCE)
+@Target(AnnotationTarget.PROPERTY, AnnotationTarget.CLASS)
+@MustBeDocumented
+/**
+ * TODO
+ */
+public annotation class TypeAdapter(val adapter: KClass<out RealmTypeAdapter<*, *>>)

packages/library-sync/src/commonMain/kotlin/io/realm/kotlin/mongodb/sync/SyncConfiguration.kt

@@ -572,7 +572,8 @@ public interface SyncConfiguration : Configuration {
                 partitionValue == null,
                 inMemory,
                 initialRealmFileConfiguration,
-                realmLogger
+                realmLogger,
+                typeAdapters,
             )
 
             return SyncConfigurationImpl(