RJS-2101: "Build optimizations" for iOS and Android

.github/workflows/publish-release.yml

@@ -53,25 +53,36 @@ jobs:
     - name: Install node modules
       run: npm ci
 
-    - name: Download prebuild artifacts from PR
-      uses: dawidd6/action-download-artifact@d0f291cf39bd21965ea9c4c6e210fc355c3844ed
+    - name: Download JSI binding source-code from PR
+      uses: dawidd6/action-download-artifact@09f2f74827fd3a8607589e5ad7f9398816f540fe
       with:
         workflow: pr-realm-js.yml
         commit: ${{ inputs.commit || github.sha }}
         path: ${{ github.workspace }}
         workflow_conclusion: "" # Ignores workflow conclusion
         github_token: ${{ secrets.REALM_CI_PAT }}
-        name: realm-js-prebuilds
+        name: jsi-binding-source
 
-    - name: Download bundle artifacts from PR
-      uses: dawidd6/action-download-artifact@d0f291cf39bd21965ea9c4c6e210fc355c3844ed
+    - name: Download TypeScript build from PR
+      uses: dawidd6/action-download-artifact@09f2f74827fd3a8607589e5ad7f9398816f540fe
       with:
         workflow: pr-realm-js.yml
         commit: ${{ inputs.commit || github.sha }}
         path: ${{ github.workspace }}
         workflow_conclusion: "" # Ignores workflow conclusion
         github_token: ${{ secrets.REALM_CI_PAT }}
-        name: realm-js-bundles
+        name: ts-build
+
+    - name: Download prebuilds from PR
+      uses: dawidd6/action-download-artifact@09f2f74827fd3a8607589e5ad7f9398816f540fe
+      with:
+        workflow: pr-realm-js.yml
+        commit: ${{ inputs.commit || github.sha }}
+        path: ${{ github.workspace }}
+        workflow_conclusion: "" # Ignores workflow conclusion
+        github_token: ${{ secrets.REALM_CI_PAT }}
+        name_is_regexp: true
+        name: +*-prebuild
 
     - name: Read version
       id: get-version

.gitignore

@@ -40,18 +40,14 @@ DerivedData
 # node.js
 node_modules/
 npm-debug.log
-build/
-/prebuilds/
 yarn.lock
 
 # Emacs
 *~
 
 # Android/IJ
 /android
-/packages/realm/react-native/android/src/main/jni/core
-/packages/realm/react-native/android/.cxx/
-/packages/realm/build-android/
+/packages/realm/binding/android/.cxx/
 .idea
 .gradle
 local.properties
@@ -96,15 +92,9 @@ coverage/
 **/imported-apps/
 **/realm-config
 
-#Ignore symlinked directories (otherwise on Windows they are shown as untracked files)
-/react-native/android/src/main/jni/vendor/
-/react-native/android/src/main/jni/src/
 /build-tmp*/
 /cmakebuild/
-/react-native/android/src/main/java/io/realm/react/Version.java
-/react-native/android/src/main/jniLibs/
 /realm*.tgz
-/react-native/ios/realm-js-ios.xcframework/
 
 # Ignore template package-lock.json files
 /templates/*/package-lock.json
@@ -114,15 +104,18 @@ coverage/
 /packages/realm/bindgen/vendor/bindgen-lib/generated/
 /packages/realm/generated/
 /packages/realm/binding/generated
+/packages/realm/binding/jsi/jsi_init.cpp
 
 # Build artifacts
 /packages/realm/dist/
 /packages/realm/binding/dist/
 /packages/realm/binding/build/
+/packages/realm/binding/android/build/
+/packages/realm/binding/node/build/
 /packages/realm/prebuilds/
-/packages/realm/react-native/android/src/main/java/io/realm/react/Version.java
-/packages/realm/react-native/android/src/main/jniLibs/
-/packages/realm/react-native/ios/realm-js-ios.xcframework/
+/packages/realm/binding/android/src/main/java/io/realm/react/Version.java
+/packages/realm/binding/android/src/main/jniLibs/
+/packages/realm/binding/apple/*.xcframework
 
 # Wireit repo caches
 .wireit

CHANGELOG.md

@@ -4,7 +4,7 @@
 * None
 
 ### Enhancements
-* None
+* Building for iOS and Android has been optimized for compatibility with future React Native versions, by deferring compilation of JSI dependent code to the dependent app's build.
 
 ### Fixed
 * <How to hit and notice issue? what was the impact?> ([#????](https://github.com/realm/realm-js/issues/????), since v?.?.?)

contrib/building.md

@@ -22,8 +22,8 @@
     - [Building for Node.js](#building-for-nodejs)
       - [Additional steps for Windows](#additional-steps-for-windows)
       - [Building for ARM/Linux](#building-for-armlinux)
-    - [Building the documentation](#building-the-documentation)
     - [Cleaning up build files](#cleaning-up-build-files)
+    - [Building the documentation](#building-the-documentation)
   - [Running the tests](#running-the-tests)
     - [Linting the source code](#linting-the-source-code)
       - [JS/TS](#jsts)
@@ -197,35 +197,60 @@ Other editors should also be able to be configured to use the `compile_commands.
 
 ## Building Realm JS
 
+In most cases, it's not required to build the SDK explicitly. You can either simply download the package from `npm` or run one of the test scripts in either of the `integration-tests/environments` (which will drive the dependent build-scripts automatically). If you want to invoke these scripts manually, see the individual sections below:
+
+### Building the SDK
+
+Most of Realm JS is platform independent code (commonly referred to as the SDK), which is built explicitly by running:
+
+```sh
+npm run build:ts --workspace realm
+```
+
 ### Building for iOS
 
 You can build and bundle for iOS by running the following command from the root directory:
 
 ```sh
-npm run build:ios --workspace realm
-npm run bundle --workspace realm
+# Pre-build Realm Core into an XCFramework
+npm run prebuild-apple --workspace realm
+# Generate the JSI binding code (to be compiled when building the consuming app)
+npm run bindgen:jsi  --workspace realm
 ```
 
+The resulting prebuilt binary is stored in `packages/realm/prebuilds/apple`.
+
 ### Building for Android
 
 You can build and bundle for Android by running the following command from the root directory:
 
 ```sh
-npm run build:android --workspace realm
-npm run bundle --workspace realm
+# Pre-build Realm Core into a CPack install directory
+npm run prebuild-android --workspace realm
+# Generate the JSI binding code (to be compiled when building the consuming app)
+npm run bindgen:jsi  --workspace realm
 ```
 
-The compiled version of the Android module is output to `<project-root>/android`.
+The resulting prebuilt binary is stored in `packages/realm/prebuilds/android`.
 
 ### Building for Node.js
 
-You can build and bundle for Node.js by running the following command from the root directory:
+You can build the native prebuilt binary for Node.js by running the following command from the root directory:
 
 ```sh
 npm run build:node --workspace realm
-npm run bundle --workspace realm
 ```
 
+The resulting prebuilt binary is the `packages/realm/prebuilds/node/realm.node` file.
+
+If you want to produce a prebuild (a OS +arch specific archive meant for distribution alongside the NPM archive):
+
+```sh
+npm run prebuild-node --workspace realm
+```
+
+The resulting prebuilt binary is stored in a `packages/realm/prebuilds/realm-*.tar.gz` file.
+
 #### Additional steps for Windows
 
 On Windows you will need to set up the environment for node-gyp:
@@ -281,7 +306,7 @@ cd realm-js
 git submodule update —-init —-recursive
 npm install --ignore-scripts
 npm run build:node --workspace realm
-npm run bundle --workspace realm
+npm run build:ts --workspace realm
 ```
 
 Finally, you can use Realm JS in your example project `MyProject`:

contrib/debug-rn-examples.md

@@ -103,13 +103,11 @@ Since we want to keep the simplicity for our users, changes made in order to deb
 
 Make sure to build binaries for Android and iOS in packages/realm by running:
 
-```
-npm run build:ios --workspace=realm
-```
-or
-
-```
-npm run build:android --workspace=realm
+```sh
+# Android
+npm run prebuild-android --workspace realm
+# Apple / iOS
+npm run prebuild-apple --workspace realm
 ```
 
 ### Building failed

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

@@ -1193,7 +1193,7 @@ PODS:
     - React-Core
     - React-jsi
   - ReactTestApp-Resources (1.0.0-dev)
-  - RealmJS (12.9.0):
+  - RealmJS (12.10.0):
     - React
   - RNFS (2.20.0):
     - React-Core
@@ -1449,11 +1449,11 @@ SPEC CHECKSUMS:
   ReactNativeHost: 35df5fb9d51dc99eaec21e993642f1232ec8b380
   ReactTestApp-DevSupport: 9052e9a0ba3a96a3cc574ee66c7b6089ee76b341
   ReactTestApp-Resources: d200e68756fa45c648f369210bd7ee0c14759f5a
-  RealmJS: e02ad90549318cff0a9c4b76e0b605e43424e8d1
+  RealmJS: 49d581b10bc4362a12818988657fff29fabe68b7
   RNFS: 4ac0f0ea233904cb798630b3c077808c06931688
   SocketRocket: abac6f5de4d4d62d24e11868d7a2f427e0ef940d
   Yoga: 348f8b538c3ed4423eb58a8e5730feec50bce372
 
-PODFILE CHECKSUM: ba37156b0bddb64052f2f6885355287c2356ac29
+PODFILE CHECKSUM: 31a428908a285ec58ff867a2a56fd19780e5be51
 
 COCOAPODS: 1.15.2