RJS-2732: Support updating the `App`'s base URL via experimental export #6518

elle-j · 2024-02-29T12:48:24Z

What, How & Why?

Experimental exports/imports

An experimental directory has been added (packages/realm/src/experimental), intended for exporting various experimental features.

Base URL

Importing "realm/experimental/base-url" will extend the App with the instance members App.baseUrl and App.updateBaseUrl(), allowing the user to retrieve and update the base URL.

TSConfig / Choosing module resolution

Importing the experimental package will only work with certain resolution algorithms. Example tsconfig.json:

{
  "compilerOptions": {
    "target": "es2022",
    "module": "node16",
    "moduleResolution": "node16",
    // ...
  }
}

Example Usage

import { App } from "realm";
import "realm/experimental/base-url";

async function exampleFunction() {
  const app = new App("my-atlas-app-id");

  // Get the currently used base URL.
  const currentBaseUrl = app.baseUrl;

  // Update the base URL.
  await app.updateBaseUrl("https://my-new-url.com");

  // Reset it to the default one.
  await app.updateBaseUrl(null);
}

This closes #6486

☑️ ToDos

📝 Changelog entry
🚦 Tests (but need to add follow-ups to skipped unimplemented tests)

packages/realm/src/experimental/base-url.ts

nirinchev

Nice! Might be worth adding a smoke test that updating the base url to a valid url also works. We could try and use realm.mongodb.com since that domain should still work.

elle-j · 2024-04-26T12:08:55Z

Just reviving the old draft implementation then I'll be modifying the test and adding some more 🙂

elle-j · 2024-04-30T11:41:21Z

integration-tests/tests/src/tests/experimental/base-url.ts

+  it.skip("updates the URL", async function (this: AppContext) {
+    // TODO
+  });


Will add this using a fetch mock.

integration-tests/environments/react-native-test-app/metro.config.js

integration-tests/tests/src/hooks/import-app-before.ts

kraenhansen · 2024-04-30T14:39:11Z

integration-tests/tests/tsconfig.common.json

@@ -3,7  3,7 @@
 		"composite": true,
 		"target": "es2022",
 		"module": "es2022",
-		"moduleResolution": "node",
+		"moduleResolution": "Bundler",


Did you check this works with npm test --workspace @realm/integration-tests (where we use raw Mocha and tsx to transpile TypeScript)?

kraenhansen · 2024-04-30T14:40:33Z

packages/realm/experimental/base-url.js

+
+// This file is needed as a workaround for Metro unexpectedly failing
+// to use the entry point defined in the package.json `exports` field,
+// despite enabling `unstable_enablePackageExports`.


Well - even if this wasn't a problem, we would probably need this file anyway, to workaround the fact that unstable_enablePackageExports is disabled by default 🤔

Also ... I know for a fact that the Metro team would be very grateful if someone would set up some tests of the metro resolver (most likely copying in tests from other packages / tools). This would make a good test case if the pattern isn't already covered by one of those other tests.

I've updated the comment to incorporate being disabled by default. Feel free to suggest any additional changes you think would be relevant for this file 👍

I'd be glad to look over some of the Metro tests and see what could be added. At first glance, it does seem like their tests are covering subpath exports.

packages/realm/src/experimental/base-url.ts

kraenhansen · 2024-04-30T14:41:23Z

integration-tests/environments/react-native-test-app/ios/Podfile.lock

@@ -1107,7  1107,7 @@ PODS:
    - React-Core
    - React-jsi
  - ReactTestApp-Resources (1.0.0-dev)
-  - RealmJS (12.7.0-rc.0):
+  - RealmJS (12.7.1):


I wonder why this was not already on main 🤔

Probably just didn't get committed 🤷‍♀️

kneth

Nice work!

Co-authored-by: Kræn Hansen <[email protected]>

elle-j · 2024-05-01T13:59:47Z

@kneth, for the final review there are only minor changes to look at:

CHANGELOG.md
packages/realm/src/experimental/base-url.ts: Per another discussion, the API updateBaseUrl() now accepts null as a way to reset the base URL to the default one (in addition to empty string).

Still missing:

Haven't got the mock fetch to work yet, so I'll add a ticket to implement the skiped tests.

cla-bot bot added the cla: yes label Feb 29, 2024

github-actions bot assigned elle-j Feb 29, 2024

kraenhansen reviewed Feb 29, 2024

View reviewed changes

packages/realm/src/experimental/base-url.ts Outdated Show resolved Hide resolved

elle-j force-pushed the lj/experimental branch from 8bc880d to de6a9ab Compare April 26, 2024 10:03

elle-j changed the title ~~Support exporting experimental features from realm/experimental~~ RJS-2732: Support updating the App's base URL via experimental export Apr 26, 2024

nirinchev approved these changes Apr 26, 2024

View reviewed changes

elle-j commented Apr 30, 2024

View reviewed changes

elle-j requested review from kneth and kraenhansen April 30, 2024 11:41

kraenhansen reviewed Apr 30, 2024

View reviewed changes

integration-tests/environments/react-native-test-app/metro.config.js Outdated Show resolved Hide resolved

kraenhansen reviewed Apr 30, 2024

View reviewed changes

integration-tests/tests/src/hooks/import-app-before.ts Show resolved Hide resolved

kraenhansen reviewed Apr 30, 2024

View reviewed changes

packages/realm/src/experimental/base-url.ts Show resolved Hide resolved

kraenhansen reviewed Apr 30, 2024

View reviewed changes

kraenhansen approved these changes Apr 30, 2024

View reviewed changes

kneth approved these changes Apr 30, 2024

View reviewed changes

elle-j added 12 commits May 1, 2024 15:50

Add experimental file to extend 'App'.

382d5e3

Expose experimental module.

8d8f468

Add getter for base url.

fb93561

Test experimental module.

1364f06

Rename module to 'base-url'.

ffd94e4

Add TS error for setting the property.

4cb4b21

Add experimental to TS docs.

3c443ae

Add implementation to the added functions.

b6977e3

Rename to 'updateBaseUrl()'.

0275ee3

Return the promise directly instead of using 'async await'.

e49a689

Update expected base url from 'realm..' to 'services.cloud..'.

b1350cf

Update public API docs.

83599ff

elle-j and others added 10 commits May 1, 2024 15:51

Update arg name.

d6dd6db

Separate tests.

f41e9af

Help Metro resolve the correct file for RN.

0e3cd2d

Isolate test for baseUrl getter.

7406cf4

Remove unstable_enablePackageExports from metro config.

1ccfd57

Co-authored-by: Kræn Hansen <[email protected]>

Update comment about the need of 'realm/experimental/base-url.js'.

47801ab

Elaborate in API docs.

dd6cbd4

Add skipped empty test for resetting URL.

ddb63b0

Allow 'null' as arg to reset the URL.

7f449eb

Add CHANGELOG entry.

1bc1027

elle-j force-pushed the lj/experimental branch from d29882a to 1bc1027 Compare May 1, 2024 13:52

elle-j marked this pull request as ready for review May 1, 2024 13:53

elle-j requested a review from kneth May 1, 2024 13:53

kneth approved these changes May 1, 2024

View reviewed changes

elle-j merged commit 7f6535f into main May 1, 2024
33 checks passed

elle-j deleted the lj/experimental branch May 1, 2024 14:34

github-actions bot locked as resolved and limited conversation to collaborators Jun 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RJS-2732: Support updating the `App`'s base URL via experimental export #6518

RJS-2732: Support updating the `App`'s base URL via experimental export #6518

elle-j commented Feb 29, 2024 •

edited

Loading

nirinchev left a comment

elle-j commented Apr 26, 2024

elle-j Apr 30, 2024 •

edited

Loading

kraenhansen Apr 30, 2024

elle-j May 1, 2024

kraenhansen Apr 30, 2024

kraenhansen Apr 30, 2024

elle-j May 1, 2024 •

edited

Loading

kraenhansen Apr 30, 2024

elle-j May 1, 2024

kneth left a comment

elle-j commented May 1, 2024

RJS-2732: Support updating the App's base URL via experimental export #6518

RJS-2732: Support updating the App's base URL via experimental export #6518

Conversation

elle-j commented Feb 29, 2024 • edited Loading

What, How & Why?

☑️ ToDos

nirinchev left a comment

Choose a reason for hiding this comment

elle-j commented Apr 26, 2024

elle-j Apr 30, 2024 • edited Loading

Choose a reason for hiding this comment

kraenhansen Apr 30, 2024

Choose a reason for hiding this comment

elle-j May 1, 2024

Choose a reason for hiding this comment

kraenhansen Apr 30, 2024

Choose a reason for hiding this comment

kraenhansen Apr 30, 2024

Choose a reason for hiding this comment

elle-j May 1, 2024 • edited Loading

Choose a reason for hiding this comment

kraenhansen Apr 30, 2024

Choose a reason for hiding this comment

elle-j May 1, 2024

Choose a reason for hiding this comment

kneth left a comment

Choose a reason for hiding this comment

elle-j commented May 1, 2024

RJS-2732: Support updating the `App`'s base URL via experimental export #6518

RJS-2732: Support updating the `App`'s base URL via experimental export #6518

elle-j commented Feb 29, 2024 •

edited

Loading

elle-j Apr 30, 2024 •

edited

Loading

elle-j May 1, 2024 •

edited

Loading