Disallow realm migration on synced realms

CHANGELOG.md

@@ -5,6 +5,7 @@ x.x.x Release notes (yyyy-MM-dd)
 
 ### Fixed
 * Fixed `create<T>(...)` deprecation warning. ([#3243](https://github.com/realm/realm-js/pull/3243))
+* Throw error when `deleteRealmIfMigrationNeeded` is requested on a synced realm (incompatible options)
 
 ### Compatibility
 * MongoDB Realm Cloud.

docs/realm.js

@@ -355,6 +355,7 @@ class Realm {
  *   - `newRealm` - The Realm that uses the latest `schema`, which should be modified as necessary.
  * @property {boolean} [deleteRealmIfMigrationNeeded=false] - Specifies if this Realm should be deleted
  *   if a migration is needed.
+ *   This option is not available on synced realms.
  * @property {callback(number, number)} [shouldCompactOnLaunch] - The function called when opening
  *   a Realm for the first time during the life of a process to determine if it should be compacted
  *   before being returned to the user. The function takes two arguments:

src/js_realm.hpp

@@ -544,6 +544,9 @@ bool RealmClass<T>::get_realm_config(ContextType ctx, size_t argc, const ValueTy
                 if (config.schema_mode == SchemaMode::Immutable) {
                     throw std::invalid_argument("Cannot set 'deleteRealmIfMigrationNeeded' when 'readOnly' is set.");
                 }
+                if (config.sync_config && config.sync_config->partition_value != "") {
+                    throw std::invalid_argument("Cannot set 'deleteRealmIfMigrationNeeded' when sync is enabled ('sync.partitionValue' is set).");
+                }
 
                 config.schema_mode = SchemaMode::ResetFile;
             }

tests/js/realm-tests.js

@@ -1609,6 +1609,27 @@ module.exports = {
             });
     },
 
+    testNoMigrationOnSync: function() {
+        if (!global.enableSyncTests) {
+            return;
+        }
+
+        const appConfig = require('./support/testConfig').integrationAppConfig;
+        let app = new Realm.App(appConfig);
+        return app.logIn(Realm.Credentials.anonymous())
+        .then(user => {
+            const config = {
+                schema: [schemas.TestObject],
+                sync: {user, partitionValue: '"Lolo"' },
+                deleteRealmIfMigrationNeeded: true,
+            };
+
+            TestCase.assertThrows(function() {
+                new Realm(config);
+            }, "Cannot set 'deleteRealmIfMigrationNeeded' when sync is enabled ('sync.partitionValue' is set).");
+        });
+    },
+
     testRealmDeleteRealmIfMigrationNeededVersionChanged: function() {
         const schema = [{
             name: 'TestObject',