feat(NODE-4938): improve react native bundle experience #578

durran · 2023-05-31T18:22:30Z

Description

Creates a new CJS bundle to be used with React Native.

What is changing?

Vendors the text-encoding and base64 modules.
Removes modifying the global object from the vendored modules.
Creates a new bson.rn.cjs artefact that imports the vendored functions for TextEncoder, TextDecoder, btoa and atob.

Is there new documentation needed for these changes?

None

What is the motivation for this change?

NODE-4938

Release Highlight

Improved React Native experience

The BSON package now ships a bundle made to work on React Native without additional polyfills preconfigured. The necessary APIs (TextEncoder/TextDecoder & atob/btoa) are now vendored into the RN bundle directly. Users should still install react-native-get-random-values themselves to get securely generated UUIDs and ObjectIds. Read more in the React Native section of our readme.

Double check the following

Ran npm run lint script
Self-review completed using the steps outlined here
PR title follows the correct format: type(NODE-xxxx)[!]: description
- Example: feat(NODE-1234)!: rewriting everything in coffeescript
Changes are covered by tests
New TODOs have a related JIRA ticket

vendor/text-encoding/index.js

nbbeeken

I updated the title to focus on the intended feature, feel free to fix it further. Let's also update the readme's section on RN with the new instructions and the intended support for this bundle

durran · 2023-06-01T15:44:00Z

I updated the title to focus on the intended feature, feel free to fix it further. Let's also update the readme's section on RN with the new instructions and the intended support for this bundle

Readme updated.

kraenhansen · 2023-06-07T11:42:36Z

README.md

@@ -188,23 +188,17 @@ try {

 ## React Native

-BSON requires that `TextEncoder`, `TextDecoder`, `atob`, `btoa`, and `crypto.getRandomValues` are available globally.  These are present in most Javascript runtimes but require polyfilling in React Native.  Polyfills for the missing functionality can be installed with the following command:
+BSON vendors the required polyfills for `TextEncoder`, `TextDecoder`, `atob`, `btoa` when using React Native. One


I suspect the term "vendors" might not be clear enough for publicly facing documentation. Perhaps it would make sense to include an explanation on what that means for the user.

Suggested change

BSON vendors the required polyfills for `TextEncoder`, `TextDecoder`, `atob`, `btoa` when using React Native. One

BSON vendors the required polyfills for `TextEncoder`, `TextDecoder`, `atob`, `btoa` imported from React Native and therefore doesn't expect users to polyfill these. One

kraenhansen · 2023-06-07T11:43:22Z

README.md

@@ -188,23 +188,17 @@ try {

 ## React Native

-BSON requires that `TextEncoder`, `TextDecoder`, `atob`, `btoa`, and `crypto.getRandomValues` are available globally.  These are present in most Javascript runtimes but require polyfilling in React Native.  Polyfills for the missing functionality can be installed with the following command:
+BSON vendors the required polyfills for `TextEncoder`, `TextDecoder`, `atob`, `btoa` when using React Native. One
+additional polyfill, `crypto.getRandomValues` is required and can be installed with the following command:


is required

Isn't this optional?

Suggested change

additional polyfill, `crypto.getRandomValues` is required and can be installed with the following command:

additional polyfill, `crypto.getRandomValues` is recommended and can be installed with the following command:

kraenhansen · 2023-06-07T11:49:43Z

etc/rollup/rollup-plugin-require-vendor/require_vendor.mjs

@@ -0,0 +1,30 @@
+import MagicString from 'magic-string';
+
+const REQUIRE_TEXT_ENCODING =


This name seam to suggest only one of the polyfills are provided here.

Changed name to REQUIRE_POLYFILLS.

kraenhansen · 2023-06-07T11:56:14Z

An alternative I don't know if you've considered: If you had a separate input for the RN bundle (which would setup the polyfills and re-export src/index.ts), you could most likely avoid the code injection / RequireVendor all together. It would require that the runtime independent code stored the polyfilled APIs on an object that the wrapping input file would then inject its functions into before importing src/index.ts. We're already using this pattern in Realm JS.

If you had a separate input file for the RN bundle, it could make sense (not necessarily for this PR) to move this check and warning into the RN bundle to avoid relying on checks of the runtime (as that tends to be brittle in my experience).

BTW: I've built the PR and tested ObjectId and UUID in a React Native app 👍

durran · 2023-06-07T15:08:08Z

An alternative I don't know if you've considered: If you had a separate input for the RN bundle (which would setup the polyfills and re-export src/index.ts), you could most likely avoid the code injection / RequireVendor all together. It would require that the runtime independent code stored the polyfilled APIs on an object that the wrapping input file would then inject its functions into before importing src/index.ts. We're already using this pattern in Realm JS.

If you had a separate input file for the RN bundle, it could make sense (not necessarily for this PR) to move this check and warning into the RN bundle to avoid relying on checks of the runtime (as that tends to be brittle in my experience).

BTW: I've built the PR and tested ObjectId and UUID in a React Native app 👍

I think that may be something we can discuss and potentially ticket in the future.

durran added 2 commits May 31, 2023 14:18

feat(NODE-4938): vendor utf8 and base64 encoding

28a307c

fix: lint

2cc844f

baileympearson reviewed May 31, 2023

View reviewed changes

vendor/text-encoding/index.js Show resolved Hide resolved

fix: only ignore root lib

91df718

baileympearson previously approved these changes May 31, 2023

View reviewed changes

baileympearson self-assigned this May 31, 2023

baileympearson added the Team Review Needs review from team label May 31, 2023

nbbeeken changed the title ~~feat(NODE-4938): vendor utf8 and base64 encoding~~ feat(NODE-4938): improve react native bundle experience May 31, 2023

nbbeeken requested changes May 31, 2023

View reviewed changes

chore: update readme

176e57b

durran dismissed baileympearson’s stale review via 176e57b June 1, 2023 15:43

durran requested a review from nbbeeken June 1, 2023 15:44

nbbeeken previously approved these changes Jun 1, 2023

View reviewed changes

kraenhansen previously approved these changes Jun 7, 2023

View reviewed changes

kraenhansen reviewed Jun 7, 2023

View reviewed changes

chore: suggestions

667342b

durran dismissed stale reviews from kraenhansen and nbbeeken via 667342b June 7, 2023 15:07

Merge branch 'main' into NODE-4938

5b9baf2

nbbeeken approved these changes Jun 7, 2023

View reviewed changes

baileympearson approved these changes Jun 7, 2023

View reviewed changes

baileympearson merged commit 7e16636 into main Jun 7, 2023

baileympearson deleted the NODE-4938 branch June 7, 2023 17:23

kraenhansen mentioned this pull request Jun 27, 2023

Add bson ^5 to peerDeps in addition to ^4 realm/realm-js#5943

Closed

11 tasks

This was referenced Jul 3, 2023

chore(main): release 5.4.0 [skip-ci] #587

Closed

chore(main): release 5.4.0 [skip-ci] #588

Merged

github-actions bot mentioned this pull request Jul 12, 2023

chore(main): release 6.0.0 [skip-ci] #591

Closed

github-actions bot mentioned this pull request May 7, 2024

chore(main): release 7.0.0 [skip-ci] #687

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(NODE-4938): improve react native bundle experience #578

feat(NODE-4938): improve react native bundle experience #578

durran commented May 31, 2023 •

edited by nbbeeken

Loading

nbbeeken left a comment

durran commented Jun 1, 2023

kraenhansen Jun 7, 2023

durran Jun 7, 2023

kraenhansen Jun 7, 2023

durran Jun 7, 2023

kraenhansen Jun 7, 2023

durran Jun 7, 2023

kraenhansen commented Jun 7, 2023 •

edited

Loading

durran commented Jun 7, 2023

	BSON vendors the required polyfills for `TextEncoder`, `TextDecoder`, `atob`, `btoa` when using React Native. One
	BSON vendors the required polyfills for `TextEncoder`, `TextDecoder`, `atob`, `btoa` imported from React Native and therefore doesn't expect users to polyfill these. One

	additional polyfill, `crypto.getRandomValues` is required and can be installed with the following command:
	additional polyfill, `crypto.getRandomValues` is recommended and can be installed with the following command:

		@@ -0,0 +1,30 @@
		import MagicString from 'magic-string';

		const REQUIRE_TEXT_ENCODING =

feat(NODE-4938): improve react native bundle experience #578

feat(NODE-4938): improve react native bundle experience #578

Conversation

durran commented May 31, 2023 • edited by nbbeeken Loading

Description

What is changing?

Is there new documentation needed for these changes?

What is the motivation for this change?

Release Highlight

Improved React Native experience

Double check the following

nbbeeken left a comment

Choose a reason for hiding this comment

durran commented Jun 1, 2023

kraenhansen Jun 7, 2023

Choose a reason for hiding this comment

durran Jun 7, 2023

Choose a reason for hiding this comment

kraenhansen Jun 7, 2023

Choose a reason for hiding this comment

durran Jun 7, 2023

Choose a reason for hiding this comment

kraenhansen Jun 7, 2023

Choose a reason for hiding this comment

durran Jun 7, 2023

Choose a reason for hiding this comment

kraenhansen commented Jun 7, 2023 • edited Loading

durran commented Jun 7, 2023

durran commented May 31, 2023 •

edited by nbbeeken

Loading

kraenhansen commented Jun 7, 2023 •

edited

Loading