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. ([#6753](https://github.com/realm/realm-js/pull/6753), since v12.8.0)
 
 ### Compatibility
 * React Native >= v0.71.4

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

@@ -411,6 +411,15 @@ describe("Flexible sync", function () {
             closeRealm(realm2);
           });
 
+          it("sets the correct path from the configuration", async function () {
+            const realm = await Realm.open({
+              path: "custom_path.realm",
+              ...getSuccessConfig(this.user, {}),
+            });
+
+            expect(realm.path).to.contain("custom_path.realm");
+          });
+
           it("does not update the subscriptions on second open if rerunOnOpen is false", async function (this: RealmContext) {
             const realm = await testSuccess(this.user, { rerunOnOpen: false }, false);
             if (!realm) throw new Error("Valid realm was not returned from testSuccess");

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