Pass in correct schema type for explicit and autodiscovered types (#2259)

LaPeste · web-flow · commit b30f384ef06f · 2021-02-24T12:25:44.000+01:00
* Wrappers can now discern if to use AdditiveExplicit or AdditiveDiscovered

* Test added, but need to rename exception

* Added RealmSchemaValidationException

* Fixed small issues

* Added entry in the Changelog and fixed a line in documentation of the new exception

* Slight improvement in the unit test

* Applied PR feedback

* Grammar fix

* More english grammar fixes

* Removed a space

* Feedback from PR applied
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ### Fixed
 * Fixed an issue that would result in UWP apps being rejected from the Microsoft Store due to an unsupported API (`__C_specific_handler`) being used. (Issue [#2235](https://github.com/realm/realm-dotnet/issues/2235))
 * Fixed a bug where applying multiple `OrderBy` clauses on a query would result in the clauses being appended to each other as if they were `.ThenBy` rather than the last clause replacing the preceding ones. (PR [#2255](https://github.com/realm/realm-dotnet/issues/2255))
+* When explicitly specifying `SyncConfiguration.ObjectTypes`, added a check to validate the schema and ensure all `EmbeddedObject` classes are reachable from a class inheriting from `RealmObject`. More info about this subject can be found [here](https://docs.mongodb.com/realm/dotnet/objects/#provide-a-subset-of-classes-to-your-realm-schema). (PR [#2259](https://github.com/realm/realm-dotnet/pull/2259))
 
 ### Enhancements
 * Add support for the `Guid` data type. It can be used as primary key and is indexable. (PR [#2120](https://github.com/realm/realm-dotnet/pull/2120))
diff --git a/Realm/Realm/Configurations/InMemoryConfiguration.cs b/Realm/Realm/Configurations/InMemoryConfiguration.cs
@@ -49,7 +49,7 @@ public InMemoryConfiguration(string identifier) : base(identifier)
 
         internal override Realm CreateRealm(RealmSchema schema)
         {
-            var configuration = CreateConfiguration();
+            var configuration = CreateNativeConfiguration();
             configuration.in_memory = true;
 
             var srPtr = SharedRealmHandle.Open(configuration, schema, EncryptionKey);
diff --git a/Realm/Realm/Configurations/RealmConfiguration.cs b/Realm/Realm/Configurations/RealmConfiguration.cs
@@ -125,7 +125,7 @@ public RealmConfiguration ConfigWithPath(string newConfigPath)
 
         internal override Realm CreateRealm(RealmSchema schema)
         {
-            var configuration = CreateConfiguration();
+            var configuration = CreateNativeConfiguration();
             configuration.delete_if_migration_needed = ShouldDeleteIfMigrationNeeded;
             configuration.read_only = IsReadOnly;
 
diff --git a/Realm/Realm/Configurations/RealmConfigurationBase.cs b/Realm/Realm/Configurations/RealmConfigurationBase.cs
@@ -150,7 +150,7 @@ internal RealmConfigurationBase Clone()
 
         internal abstract Task<Realm> CreateRealmAsync(RealmSchema schema, CancellationToken cancellationToken);
 
-        internal Native.Configuration CreateConfiguration()
+        internal Native.Configuration CreateNativeConfiguration()
         {
             return new Native.Configuration
             {
diff --git a/Realm/Realm/Configurations/SyncConfiguration.cs b/Realm/Realm/Configurations/SyncConfiguration.cs
@@ -122,9 +122,10 @@ private SyncConfiguration(object partition, User user, string path)
 
         internal override Realm CreateRealm(RealmSchema schema)
         {
-            var configuration = CreateConfiguration();
+            var configuration = CreateNativeConfiguration();
+            var syncConfiguration = CreateNativeSyncConfiguration();
 
-            var srHandle = SharedRealmHandle.OpenWithSync(configuration, ToNative(), schema, EncryptionKey);
+            var srHandle = SharedRealmHandle.OpenWithSync(configuration, syncConfiguration, schema, EncryptionKey);
             if (IsDynamic && !schema.Any())
             {
                 srHandle.GetSchema(nativeSchema => schema = RealmSchema.CreateFromObjectStoreSchema(nativeSchema));
@@ -136,14 +137,15 @@ internal override Realm CreateRealm(RealmSchema schema)
         [SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "The Realm instance will own its handle")]
         internal override async Task<Realm> CreateRealmAsync(RealmSchema schema, CancellationToken cancellationToken)
         {
-            var configuration = CreateConfiguration();
+            var configuration = CreateNativeConfiguration();
+            var syncConfiguration = CreateNativeSyncConfiguration();
 
             var tcs = new TaskCompletionSource<ThreadSafeReferenceHandle>();
             var tcsHandle = GCHandle.Alloc(tcs);
             ProgressNotificationToken progressToken = null;
             try
             {
-                using var handle = SharedRealmHandle.OpenWithSyncAsync(configuration, ToNative(), schema, EncryptionKey, tcsHandle);
+                using var handle = SharedRealmHandle.OpenWithSyncAsync(configuration, syncConfiguration, schema, EncryptionKey, tcsHandle);
                 cancellationToken.Register(() =>
                 {
                     if (!handle.IsClosed)
@@ -187,14 +189,15 @@ internal override async Task<Realm> CreateRealmAsync(RealmSchema schema, Cancell
             }
         }
 
-        internal Native.SyncConfiguration ToNative()
+        internal Native.SyncConfiguration CreateNativeSyncConfiguration()
         {
             return new Native.SyncConfiguration
             {
                 SyncUserHandle = User.Handle,
                 Partition = Partition.ToNativeJson(),
                 session_stop_policy = SessionStopPolicy,
+                schema_mode = ObjectClasses == null ? SchemaMode.AdditiveDiscovered : SchemaMode.AdditiveExplicit,
             };
         }
     }
-}
+}
diff --git a/Realm/Realm/Exceptions/RealmException.cs b/Realm/Realm/Exceptions/RealmException.cs
@@ -104,6 +104,9 @@ internal static Exception Create(RealmExceptionCodes exceptionCode, string messa
                 case RealmExceptionCodes.RealmClosed:
                     return new RealmClosedException(message);
 
+                case RealmExceptionCodes.RealmSchemaValidation:
+                    return new RealmSchemaValidationException(message);
+
                 case RealmExceptionCodes.NotNullableProperty:
                 case RealmExceptionCodes.PropertyMismatch:
                     return new RealmException(message);
diff --git a/Realm/Realm/Exceptions/RealmExceptionCodes.cs b/Realm/Realm/Exceptions/RealmExceptionCodes.cs
@@ -36,6 +36,8 @@ internal enum RealmExceptionCodes : sbyte
         RealmInvalidTransaction = 10,
         RealmFormatUpgradeRequired = 13,
         RealmSchemaMismatch = 14,
+        RealmSchemaValidation = 15,
+
         RealmRowDetached = 21,
         RealmTableHasNoPrimaryKey = 22,
         RealmDuplicatePrimaryKeyValue = 23,
diff --git a/Realm/Realm/Exceptions/RealmSchemaValidationException.cs b/Realm/Realm/Exceptions/RealmSchemaValidationException.cs
@@ -0,0 +1,34 @@
+////////////////////////////////////////////////////////////////////////////
+//
+// Copyright 2021 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.
+//
+////////////////////////////////////////////////////////////////////////////
+
+namespace Realms.Exceptions
+{
+    /// <summary>
+    /// Exception thrown when the schema specified in your C# models doesn't pass validation for the type of Realm you're trying to open.
+    /// The message contains information about the validation errors and how to correct them.
+    /// </summary>
+    /// <seealso href="https://docs.mongodb.com/realm/dotnet/realms/#std-label-dotnet-realm-schema">
+    /// General information about Realm's schema.
+    /// </seealso>
+    public class RealmSchemaValidationException : RealmException
+    {
+        internal RealmSchemaValidationException(string detailMessage) : base(detailMessage)
+        {
+        }
+    }
+}
diff --git a/Realm/Realm/Native/SyncConfiguration.cs b/Realm/Realm/Native/SyncConfiguration.cs
@@ -49,5 +49,7 @@ internal string Partition
         }
 
         internal SessionStopPolicy session_stop_policy;
+
+        internal SchemaMode schema_mode;
     }
 }
diff --git a/Realm/Realm/Sync/SchemaMode.cs b/Realm/Realm/Sync/SchemaMode.cs
@@ -0,0 +1,29 @@
+﻿////////////////////////////////////////////////////////////////////////////
+//
+// Copyright 2021 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.
+//
+////////////////////////////////////////////////////////////////////////////
+
+namespace Realms.Sync
+{
+    /// <summary>
+    /// To see details of each mode check its mirroring definition in core.
+    /// </summary>
+    internal enum SchemaMode : byte
+    {
+        AdditiveDiscovered = 4,
+        AdditiveExplicit = 5
+    }
+}
diff --git a/Tests/Realm.Tests/Sync/SynchronizedInstanceTests.cs b/Tests/Realm.Tests/Sync/SynchronizedInstanceTests.cs
@@ -22,6 +22,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using NUnit.Framework;
+using Realms.Exceptions;
 using Realms.Schema;
 using Realms.Sync;
 using Realms.Sync.Exceptions;
@@ -271,6 +272,15 @@ public void InvalidSchemaChange_RaisesClientReset()
             });
         }
 
+        [Test]
+        public void EmbeddedObject_WhenAdditiveExplicit_ShouldThrow()
+        {
+            var conf = GetFakeConfig();
+            conf.ObjectClasses = new[] { typeof(EmbeddedLevel3) };
+
+            Assert.Throws<RealmSchemaValidationException>(() => Realm.GetInstance(conf), $"Embedded object {nameof(EmbeddedLevel3)} is unreachable by any link path from top level objects");
+        }
+
         private const int DummyDataSize = 100;
 
         private static void AddDummyData(Realm realm, bool singleTransaction)
diff --git a/wrappers/src/error_handling.cpp b/wrappers/src/error_handling.cpp
@@ -62,8 +62,8 @@ namespace realm {
                 return { RealmErrorType::RealmError, e.what() };
             }
         }
-        catch (const SchemaValidationException& e) { // an ObjectStore exception mapped onto same code as older core
-            return { RealmErrorType::RealmFormatUpgradeRequired, e.what() };
+        catch (const SchemaValidationException& e) {
+            return { RealmErrorType::RealmSchemaValidation, e.what() };
         }
         catch (const MismatchedConfigException& e) {
             return { RealmErrorType::RealmMismatchedConfig, e.what() };
diff --git a/wrappers/src/realm_error_type.hpp b/wrappers/src/realm_error_type.hpp
@@ -64,6 +64,8 @@ namespace realm {
 
         RealmSchemaMismatch = 14,
 
+        RealmSchemaValidation = 15,
+
         RealmRowDetached = 21,
 
         RealmTableHasNoPrimaryKey = 22,
diff --git a/wrappers/src/shared_realm_cs.cpp b/wrappers/src/shared_realm_cs.cpp
@@ -71,7 +71,7 @@ class TestHelper {
 Realm::Config get_shared_realm_config(Configuration configuration, SyncConfiguration sync_configuration, SchemaObject* objects, int objects_length, SchemaProperty* properties, uint8_t* encryption_key)
 {
     Realm::Config config;
-    config.schema_mode = SchemaMode::AdditiveDiscovered;
+    config.schema_mode = sync_configuration.schema_mode;
 
     if (objects_length > 0) {
         config.schema = create_schema(objects, objects_length, properties);
diff --git a/wrappers/src/shared_realm_cs.hpp b/wrappers/src/shared_realm_cs.hpp
@@ -73,6 +73,8 @@ struct SyncConfiguration
     size_t url_len;
 
     SyncSessionStopPolicy session_stop_policy;
+
+    SchemaMode schema_mode;
 };
 
 inline const TableRef get_table(const SharedRealm& realm, TableKey table_key)

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ public InMemoryConfiguration(string identifier) : base(identifier)`
`49`	`49`
`50`	`50`	`internal override Realm CreateRealm(RealmSchema schema)`
`51`	`51`	`{`
`52`		`- var configuration = CreateConfiguration();`
	`52`	`+ var configuration = CreateNativeConfiguration();`
`53`	`53`	`configuration.in_memory = true;`
`54`	`54`
`55`	`55`	`var srPtr = SharedRealmHandle.Open(configuration, schema, EncryptionKey);`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ public RealmConfiguration ConfigWithPath(string newConfigPath)`
`125`	`125`
`126`	`126`	`internal override Realm CreateRealm(RealmSchema schema)`
`127`	`127`	`{`
`128`		`- var configuration = CreateConfiguration();`
	`128`	`+ var configuration = CreateNativeConfiguration();`
`129`	`129`	`configuration.delete_if_migration_needed = ShouldDeleteIfMigrationNeeded;`
`130`	`130`	`configuration.read_only = IsReadOnly;`
`131`	`131`
Original file line number	Diff line number	Diff line change
`@@ -150,7 +150,7 @@ internal RealmConfigurationBase Clone()`
`150`	`150`
`151`	`151`	`internal abstract Task<Realm> CreateRealmAsync(RealmSchema schema, CancellationToken cancellationToken);`
`152`	`152`
`153`		`- internal Native.Configuration CreateConfiguration()`
	`153`	`+ internal Native.Configuration CreateNativeConfiguration()`
`154`	`154`	`{`
`155`	`155`	`return new Native.Configuration`
`156`	`156`	`{`
Original file line number	Diff line number	Diff line change
`@@ -122,9 +122,10 @@ private SyncConfiguration(object partition, User user, string path)`
`122`	`122`
`123`	`123`	`internal override Realm CreateRealm(RealmSchema schema)`
`124`	`124`	`{`
`125`		`- var configuration = CreateConfiguration();`
	`125`	`+ var configuration = CreateNativeConfiguration();`
	`126`	`+ var syncConfiguration = CreateNativeSyncConfiguration();`
`126`	`127`
`127`		`- var srHandle = SharedRealmHandle.OpenWithSync(configuration, ToNative(), schema, EncryptionKey);`
	`128`	`+ var srHandle = SharedRealmHandle.OpenWithSync(configuration, syncConfiguration, schema, EncryptionKey);`
`128`	`129`	`if (IsDynamic && !schema.Any())`
`129`	`130`	`{`
`130`	`131`	`srHandle.GetSchema(nativeSchema => schema = RealmSchema.CreateFromObjectStoreSchema(nativeSchema));`
`@@ -136,14 +137,15 @@ internal override Realm CreateRealm(RealmSchema schema)`
`136`	`137`	`[SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "The Realm instance will own its handle")]`
`137`	`138`	`internal override async Task<Realm> CreateRealmAsync(RealmSchema schema, CancellationToken cancellationToken)`
`138`	`139`	`{`
`139`		`- var configuration = CreateConfiguration();`
	`140`	`+ var configuration = CreateNativeConfiguration();`
	`141`	`+ var syncConfiguration = CreateNativeSyncConfiguration();`
`140`	`142`
`141`	`143`	`var tcs = new TaskCompletionSource<ThreadSafeReferenceHandle>();`
`142`	`144`	`var tcsHandle = GCHandle.Alloc(tcs);`
`143`	`145`	`ProgressNotificationToken progressToken = null;`
`144`	`146`	`try`
`145`	`147`	`{`
`146`		`- using var handle = SharedRealmHandle.OpenWithSyncAsync(configuration, ToNative(), schema, EncryptionKey, tcsHandle);`
	`148`	`+ using var handle = SharedRealmHandle.OpenWithSyncAsync(configuration, syncConfiguration, schema, EncryptionKey, tcsHandle);`
`147`	`149`	`cancellationToken.Register(() =>`
`148`	`150`	`{`
`149`	`151`	`if (!handle.IsClosed)`
`@@ -187,14 +189,15 @@ internal override async Task<Realm> CreateRealmAsync(RealmSchema schema, Cancell`
`187`	`189`	`}`
`188`	`190`	`}`
`189`	`191`
`190`		`- internal Native.SyncConfiguration ToNative()`
	`192`	`+ internal Native.SyncConfiguration CreateNativeSyncConfiguration()`
`191`	`193`	`{`
`192`	`194`	`return new Native.SyncConfiguration`
`193`	`195`	`{`
`194`	`196`	`SyncUserHandle = User.Handle,`
`195`	`197`	`Partition = Partition.ToNativeJson(),`
`196`	`198`	`session_stop_policy = SessionStopPolicy,`
	`199`	`+ schema_mode = ObjectClasses == null ? SchemaMode.AdditiveDiscovered : SchemaMode.AdditiveExplicit,`
`197`	`200`	`};`
`198`	`201`	`}`
`199`	`202`	`}`
`200`		`-}`
	`203`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -49,5 +49,7 @@ internal string Partition`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`internal SessionStopPolicy session_stop_policy;`
	`52`	`+`
	`53`	`+ internal SchemaMode schema_mode;`
`52`	`54`	`}`
`53`	`55`	`}`