Replace "rollup" bundling with TypeScript project references (realm#6492

)

* Adding a "build" script to SDK using TS project references

* Removed "realm:bundle" in favour of "realm:build"

* Downgrading "module" of shared code to es2015

* Fixing up unit tests

* Exporting "bare" types from @realm/fetch

* Building only commonjs for now

* WIP

* No named exports only cjs

* Moving public types into dist

* Marking toFetchArgs as @internal

* Minor changes to platforms

* Stop generating TS via Cmake

* Seperating "node-wrapper" bindgen into two separate templates reusing a base

* Injecting binding instead of importing "realm/binding"

* Adding a script to clean the SDK package

* No need to emit the native.d.ts in the platform directories anymore

* Moved patching of binding to a  function called after injection

* Fixed relative paths in tsconfig.json

* Adding documentation on applyPatch

* Emitting source-maps

* Renaming "build" script to "build:typescript"

* Moved deprecated global Realm into its own file

* Refactored namespace API

* Renamed "build" to "build:typescript" across depending packages

* Expose Auth on the namespace

* Renamed "realm:build:typescript" to "realm:build:ts"

* Waypoint

* Adding a "check-types" script

* Adding @internal tags

* Exposing Realm on the Realm namespace to help ease ESM transition

* Adding a comment

* Removed the tsconfig.base.json

* Removed an extraneous internal tag

* Adding transpilation as a dep of "test"

* Fixed running tests and building from scratch

* Fixed tests (again)

* Fixed missing import in @realm/react

* Exporting the namespace deprecated-global.ts

* Fixed test coverage

* Removed the build:ts:instrumented script again

* Adding binding sourcecode to the dist artifact upload

* Fixing namespace errors

* Fixed lint error

* Adding a Jest wrapper for the RN entrypoint

* Attempt at fixing coverage

* Incorporating feedback

* Fixed tsconfigs

* Adding binding files to package files

* Fixed output of bindgen:generate:typescript

.github/workflows/pr-realm-js.yml

@@ -48,6 +48,8 @@ jobs:
           path: |
             README.md
             packages/*/dist
+            packages/realm/binding/dist
+            packages/realm/binding/generated
 
   build:
     name: Build for ${{ matrix.variant.os }} ${{ matrix.variant.arch }}

.gitignore

@@ -113,9 +113,12 @@ coverage/
 # Generated artifacts
 /packages/realm/bindgen/vendor/bindgen-lib/generated/
 /packages/realm/generated/
+/packages/realm/binding/generated
 
 # Build artifacts
 /packages/realm/dist/
+/packages/realm/binding/dist/
+/packages/realm/binding/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/

integration-tests/environments/electron/package.json

@@ -25,15 +25,15 @@
     "test:main": {
       "command": "mocha-remote --reporter @realm/mocha-reporter --id main tsx runner.ts main",
       "dependencies": [
-        "../../../packages/realm:bundle",
+        "../../../packages/realm:build:ts",
         "../../../packages/realm:build:node",
         "../../../packages/mocha-reporter:bundle"
       ]
     },
     "test:renderer": {
       "command": "mocha-remote --reporter @realm/mocha-reporter --id renderer tsx runner.ts renderer",
       "dependencies": [
-        "../../../packages/realm:bundle",
+        "../../../packages/realm:build:ts",
         "../../../packages/realm:build:node",
         "../../../packages/mocha-reporter:bundle"
       ]

integration-tests/environments/node/package.json

@@ -13,15 +13,15 @@
     "test": {
       "command": "mocha-remote --reporter @realm/mocha-reporter tsx index.mjs",
       "dependencies": [
-        "../../../packages/realm:bundle",
+        "../../../packages/realm:build:ts",
         "../../../packages/realm:build:node",
         "../../../packages/mocha-reporter:bundle"
       ]
     },
     "test:commonjs": {
       "command": "mocha-remote --reporter @realm/mocha-reporter tsx index.cjs",
       "dependencies": [
-        "../../../packages/realm:bundle",
+        "../../../packages/realm:build:ts",
         "../../../packages/realm:build:node",
         "../../../packages/mocha-reporter:bundle"
       ]

integration-tests/environments/react-native/package.json

@@ -98,7 +98,7 @@
       "command": "npm run common",
       "dependencies": [
         "../../../packages/realm:build:android",
-        "../../../packages/realm:bundle",
+        "../../../packages/realm:build:ts",
         "../../../packages/mocha-reporter:bundle"
       ],
       "env": {
@@ -116,7 +116,7 @@
       "command": "npm run common",
       "dependencies": [
         "pod-install:simulator",
-        "../../../packages/realm:bundle",
+        "../../../packages/realm:build:ts",
         "../../../packages/mocha-reporter:bundle"
       ],
       "env": {
@@ -128,7 +128,7 @@
       "command": "npm run common",
       "dependencies": [
         "pod-install:catalyst",
-        "../../../packages/realm:bundle",
+        "../../../packages/realm:build:ts",
         "../../../packages/mocha-reporter:bundle"
       ],
       "env": {
@@ -155,7 +155,7 @@
       "command": "npm run common",
       "dependencies": [
         "../../../packages/realm:build:android",
-        "../../../packages/realm:bundle",
+        "../../../packages/realm:build:ts",
         "../../../packages/mocha-reporter:bundle"
       ],
       "env": {
@@ -168,7 +168,7 @@
       "dependencies": [
         "pod-install:simulator",
         "../../../packages/realm:build:ios:debug:simulator",
-        "../../../packages/realm:bundle",
+        "../../../packages/realm:build:ts",
         "../../../packages/mocha-reporter:bundle"
       ],
       "env": {
@@ -181,7 +181,7 @@
       "dependencies": [
         "pod-install:catalyst",
         "../../../packages/realm:build:ios:debug:catalyst",
-        "../../../packages/realm:bundle",
+        "../../../packages/realm:build:ts",
         "../../../packages/mocha-reporter:bundle"
       ],
       "env": {

integration-tests/tests/.mocharc.json

@@ -6,6 +6,9 @@
     "no-warnings"
   ],
   "reporter": "@realm/mocha-reporter",
-  "require": "src/node/inject-globals.ts",
+  "require": [
+    "source-map-support/register",
+    "src/node/inject-globals.ts"
+  ],
   "spec": "src/index.ts"
 }

integration-tests/tests/.nycrc.json

@@ -1,8 +1,7 @@
 {
-  "extends": "@istanbuljs/nyc-config-typescript",
-  "all": true,
   "cwd": "../..",
   "include": [
+    "packages/realm/dist/**",
     "packages/realm/src/**"
   ]
 }

integration-tests/tests/package.json

@@ -20,46 +20,42 @@
     "lint": {
       "command": "eslint --ext .js,.ts . && tsc --noEmit",
       "dependencies": [
-        "../../packages/realm:bundle"
+        "build-dependencies"
       ]
     },
     "build": {
       "command": "tsc",
       "dependencies": [
-        "../../packages/realm:bundle",
         "build-dependencies"
       ]
     },
     "start": {
       "command": "mocha --watch",
       "dependencies": [
-        "../../packages/realm:bundle",
         "build-dependencies"
       ]
     },
     "test": {
       "command": "mocha --exit",
       "dependencies": [
-        "../../packages/realm:bundle",
         "build-dependencies"
       ]
     },
     "coverage": {
       "command": "nyc mocha --exit",
       "dependencies": [
-        "../../packages/realm:bundle:coverage",
         "build-dependencies"
       ]
     },
     "ci:coverage": {
       "command": "nyc --reporter=lcov -- mocha --exit",
       "dependencies": [
-        "../../packages/realm:bundle:coverage",
         "build-dependencies"
       ]
     },
     "build-dependencies": {
       "dependencies": [
+        "../../packages/realm:build:ts",
         "../../packages/realm:build:node",
         "../../packages/mocha-reporter:bundle"
       ]
@@ -69,7 +65,6 @@
     "realm": "*"
   },
   "devDependencies": {
-    "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@realm/app-importer": "*",
     "@realm/mocha-reporter": "*",
     "@thi.ng/bench": "^3.1.16",

integration-tests/tests/src/tests/migrations.ts

@@ -18,7 +18,6 @@
 import Realm from "realm";
 import { expect } from "chai";
 import { DogSchema, IDog, IPerson, PersonSchema } from "../schemas/person-and-dogs";
-import { BSON } from "realm/dist/bundle";
 
 const TestSchema = {
   name: "Test",

package.json

@@ -17,12 +17,12 @@
     "build": {
       "dependencies": [
         "bundle",
-        "./packages/realm:build"
+        "./packages/realm:build:ts"
       ]
     },
     "bundle": {
       "dependencies": [
-        "./packages/realm:bundle",
+        "./packages/realm:build:ts",
         "./packages/babel-plugin:bundle",
         "./packages/mocha-reporter:bundle",
         "./packages/realm-react:bundle",
@@ -78,6 +78,7 @@
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-replace": "^5.0.5",
     "@rollup/plugin-typescript": "^11.1.6",
+    "@tsconfig/node-lts": "^20.1.1",
     "@typescript-eslint/eslint-plugin": "^5.60.0",
     "@typescript-eslint/parser": "^5.60.0",
     "clang-format": "^1.8.0",

packages/babel-plugin/package.json

@@ -23,7 +23,8 @@
     "test": {
       "command": "jest",
       "dependencies": [
-        "../realm:bundle"
+        "../realm:build:ts",
+        "../realm:bindgen:build:typescript"
       ]
     }
   },

packages/fetch/package.json

@@ -21,13 +21,13 @@
     }
   },
   "exports": {
+    "types": "./dist/types/types.d.ts",
     "node": {
       "import": "./dist/node-esm/node.js",
       "require": "./dist/node-cjs/node.js"
     },
     "react-native": "./dist/react-native/react-native.js",
-    "browser": "./dist/browser/browser.js",
-    "types": "./dist/types/types.d.ts"
+    "browser": "./dist/browser/browser.js"
   },
   "react-native": "./dist/react-native/react-native.js",
   "types": "./dist/types/types.d.ts",

packages/fetch/tsconfig.node.base.json

@@ -4,6 +4,7 @@
     "@tsconfig/node18/tsconfig.json",
   ],
   "files": [
-    "src/node.ts"
+    "src/node.ts",
+    "src/types.ts"
   ]
 }

packages/fetch/tsconfig.node.cjs.json

@@ -2,7 +2,8 @@
   "extends": "./tsconfig.node.base.json",
   "compilerOptions": {
     "outDir": "./dist/node-cjs",
-    "module": "CommonJS"
+    "module": "Node16",
+    "moduleResolution": "Node16"
   },
   "references": [
     { "path": "tsconfig.types.json" }

packages/fetch/tsconfig.node.esm.json

@@ -2,7 +2,8 @@
   "extends": "./tsconfig.node.base.json",
   "compilerOptions": {
     "outDir": "./dist/node-esm",
-    "module": "ES2022"
+    "module": "es2022",
+    "moduleResolution": "Bundler"
   },
   "references": [
     { "path": "tsconfig.types.json" }

packages/realm-react/package.json

@@ -18,7 +18,7 @@
     "bundle": {
       "command": "rollup --config && tsc -p tsconfig.types.json",
       "dependencies": [
-        "../realm:bundle",
+        "../realm:build:ts",
         "../realm-common:bundle"
       ],
       "files": [
@@ -33,7 +33,7 @@
     "test": {
       "command": "jest --forceExit",
       "dependencies": [
-        "../realm:bundle",
+        "../realm:build:ts",
         "../realm:build:node",
         "../realm-common:bundle",
         "../realm-app-importer:type-check"

packages/realm-react/src/UserProvider.tsx

@@ -17,6 +17,7 @@
 ////////////////////////////////////////////////////////////////////////////
 
 import React, { createContext, useContext, useEffect, useState } from "react";
+import type Realm from "realm";
 
 import { useApp } from "./AppProvider";
 

packages/realm-tools/package.json

@@ -17,7 +17,7 @@
     "build": {
       "command": "tsc -p tsconfig.build.json",
       "dependencies": [
-        "../realm:bundle"
+        "../realm:build:ts"
       ],
       "files": [
         "tsconfig.build.json",

packages/realm/.eslintignore

@@ -2,3 +2,6 @@ dist/
 docs/
 bindgen/vendor/realm-core/
 src/tests/realms/
+
+# Files transpiled by babel from generated files
+binding/generated/*.cjs