Added missing docs and tests for WriteCopy when using flexible sync (…

…#3476)
realm · Nov 10, 2023 · 13135ad · 13135ad
1 parent b4a9906
commit 13135ad
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 0 deletions.
diff --git a/Realm/Realm/Realm.cs b/Realm/Realm/Realm.cs
@@ -1308,12 +1308,25 @@ public void RemoveAll()
         /// 3. When using Sync, it is required that all local changes are synchronized with the server before the copy can be written.
         ///    This is to be sure that the file can be used as a starting point for a newly installed application.
         ///    The function will throw if there are pending uploads.
+        /// 4. Writing a copy to a flexible sync realm is not supported unless flexible sync is already enabled.
+        /// 5  Changing from flexible sync sync to partition based sync is not supported.
+        /// 6. Changing the partition to synchronize on is not supported.
         /// </remarks>
         /// <param name="config">Configuration, specifying the path and optionally the encryption key for the copy.</param>
         public void WriteCopy(RealmConfigurationBase config)
         {
             Argument.NotNull(config, nameof(config));
 
+            if (config is FlexibleSyncConfiguration && Config is not FlexibleSyncConfiguration)
+            {
+                throw new NotSupportedException("Writing a copy to a flexible sync realm is not supported unless flexible sync is already enabled");
+            }
+
+            if (config is PartitionSyncConfiguration && Config is FlexibleSyncConfiguration)
+            {
+                throw new NotSupportedException("Changing from flexible sync sync to partition based sync is not supported when writing a Realm copy.");
+            }
+
             if (Config is PartitionSyncConfiguration originalConfig && config is PartitionSyncConfiguration copiedConfig && originalConfig.Partition != copiedConfig.Partition)
             {
                 throw new NotSupportedException($"Changing the partition to synchronize on is not supported when writing a Realm copy. Original partition: {originalConfig.Partition}, passed partition: {copiedConfig.Partition}");

diff --git a/Tests/Realm.Tests/Sync/SynchronizedInstanceTests.cs b/Tests/Realm.Tests/Sync/SynchronizedInstanceTests.cs
@@ -609,6 +609,45 @@ public void WriteCopy_FailsWithEmptyConfig()
             });
         }
 
+        [Test]
+        public void WriteCopy_ThrowsWhenConvertingFromLocalToFLX()
+        {
+            SyncTestHelpers.RunBaasTestAsync(async () =>
+            {
+                using var localRealm = GetRealm();
+                var flexConfig = await GetFLXIntegrationConfigAsync();
+
+                var ex = Assert.Throws<NotSupportedException>(() => localRealm.WriteCopy(flexConfig))!;
+                Assert.That(ex.Message, Does.Contain("Writing a copy to a flexible sync realm is not supported unless flexible sync is already enabled"));
+            });
+        }
+
+        [Test]
+        public void WriteCopy_ThrowsWhenConvertingFromPBSToFLX()
+        {
+            SyncTestHelpers.RunBaasTestAsync(async () =>
+            {
+                using var pbsRealm = await GetIntegrationRealmAsync();
+                var flexConfig = await GetFLXIntegrationConfigAsync();
+
+                var ex = Assert.Throws<NotSupportedException>(() => pbsRealm.WriteCopy(flexConfig))!;
+                Assert.That(ex.Message, Does.Contain("Writing a copy to a flexible sync realm is not supported unless flexible sync is already enabled"));
+            });
+        }
+
+        [Test]
+        public void WriteCopy_ThrowsWhenConvertingFromFLXToPBS()
+        {
+            SyncTestHelpers.RunBaasTestAsync(async () =>
+            {
+                using var flxRealm = await GetFLXIntegrationRealmAsync();
+                var pbsConfig = await GetIntegrationConfigAsync();
+
+                var ex = Assert.Throws<NotSupportedException>(() => flxRealm.WriteCopy(pbsConfig))!;
+                Assert.That(ex.Message, Does.Contain("Changing from flexible sync sync to partition based sync is not supported when writing a Realm copy"));
+            });
+        }
+
         [Test]
         public void DeleteRealmWorksIfCalledMultipleTimes()
         {