RJS-2846: Fix path configuration when using sync

CHANGELOG.md

@@ -7,8 +7,7 @@
 * None
 
 ### Fixed
-* <How to hit and notice issue? what was the impact?> ([#????](https://github.com/realm/realm-js/issues/????), since v?.?.?)
-* None
+* `path` option in the Realm configuration not being set when using a synced Realm. ([#6754](https://github.com/realm/realm-js/issues/6754), since v12.8.0). Note: if you have been using a custom path configuration with your synced Realm, this fix will lead to a re-download of its data in the custom path.
 
 ### Compatibility
 * React Native >= v0.71.4

integration-tests/tests/src/tests/sync/realm.ts

@@ -2111,21 +2111,45 @@ describe("Realmtest", () => {
   describe("with sync", () => {
     importAppBefore(buildAppConfig("with-anon").anonAuth().partitionBasedSync());
 
-    it("data is deleted on realm with custom path", function (this: RealmContext & AppContext) {
-      return this.app.logIn(Realm.Credentials.anonymous()).then(async (user) => {
-        const config = {
-          schema: [TestObjectWithPkSchema],
-          sync: { user, partitionValue: '"Lolo"' },
-        };
-        const realm = new Realm(config);
-        const path = realm.path;
-        realm.close();
-        const pathExistBeforeDelete = await fs.exists(path);
-        expect(pathExistBeforeDelete).to.be.true;
-        Realm.deleteFile(config);
-        const pathExistAfterDelete = await fs.exists(path);
-        expect(pathExistAfterDelete).to.be.false;
-      });
+    it("custom path gets correctly set", async function (this: RealmContext & AppContext) {
+      const user = await this.app.logIn(Realm.Credentials.anonymous());
+      const testPath = "custom_path.realm";
+      const pathSeparator = "/";
+      const defaultDir =
+        Realm.defaultPath.substring(0, Realm.defaultPath.lastIndexOf(pathSeparator) + 1) +
+        "mongodb-realm" +
+        pathSeparator +
+        this.app.id +
+        pathSeparator +
+        user.id +
+        pathSeparator;
+
+      const realm = await Realm.open({
+        path: testPath,
+        schema: [TestObjectWithPkSchema],
+        sync: { user, partitionValue: '"Lolo"' },
+      });
+      expect(realm.path).equals(defaultDir + testPath);
+      const path = realm.path;
+      realm.close();
+      const pathExistAfterInitialization = await fs.exists(path);
+      expect(pathExistAfterInitialization).to.be.true;
+    });
+
+    it("data is deleted on realm with custom path", async function (this: RealmContext & AppContext) {
+      const user = await this.app.logIn(Realm.Credentials.anonymous());
+      const config = {
+        schema: [TestObjectWithPkSchema],
+        sync: { user, partitionValue: '"Lolo"' },
+      };
+      const realm = new Realm(config);
+      const path = realm.path;
+      realm.close();
+      const pathExistBeforeDelete = await fs.exists(path);
+      expect(pathExistBeforeDelete).to.be.true;
+      Realm.deleteFile(config);
+      const pathExistAfterDelete = await fs.exists(path);
+      expect(pathExistAfterDelete).to.be.false;
     });
   });
 

packages/realm/src/Realm.ts

@@ -385,7 +385,7 @@
         return Realm.normalizePath(config.path);
       } else {
         const bindingSyncConfig = toBindingSyncConfig(config.sync);
-        return config.sync.user.internal.pathForRealm(bindingSyncConfig, undefined);
+        return config.sync.user.internal.pathForRealm(bindingSyncConfig, config.path);
       }
     } else {
       return Realm.normalizePath(config.path);
@@ -839,7 +839,7 @@
 
   /**
    * Deletes a Realm model, including all of its objects.
    * If called outside a migration function, {@link schema} and {@link schemaVersion} are updated.
    * @param name - The model name.
    */
   deleteModel(name: string): void {
@@ -1001,7 +1001,7 @@
    * Remove the listener {@link callback} for the specified event {@link eventName}.
    * @param eventName - The event name.
    * @param callback - Function that was previously added as a listener for this event through the {@link addListener} method.
    * @throws an {@link Error} If an invalid event {@link eventName} is supplied, if Realm is closed or if {@link callback} is not a function.
    */
   removeListener(eventName: RealmEventName, callback: RealmListenerCallback): void {
     assert.open(this);
@@ -1045,7 +1045,7 @@
   }
 
   /**
    * Synchronously call the provided {@link callback} inside a write transaction. If an exception happens inside a transaction,
    * you’ll lose the changes in that transaction, but the Realm itself won’t be affected (or corrupted).
    * More precisely, {@link beginTransaction} and {@link commitTransaction} will be called
    * automatically. If any exception is thrown during the transaction {@link cancelTransaction} will