Upgrade to SpiderMonkey 137 (#584)

* Update SpiderMonkey

Signed-off-by: Josh Matthews <[email protected]>

* Update COMMIT.

Signed-off-by: Josh Matthews <[email protected]>

* Update patches.

Signed-off-by: Josh Matthews <[email protected]>

* Apply patches.

Signed-off-by: Josh Matthews <[email protected]>

* Update handwritten glue.

Signed-off-by: Josh Matthews <[email protected]>

* Update jsapi wrappers.

Signed-off-by: Josh Matthews <[email protected]>

* Build fixes.

Signed-off-by: Josh Matthews <[email protected]>

* Formatting.

Signed-off-by: Josh Matthews <[email protected]>

* Set pending exception in panic unit test to avoid assertion.

Signed-off-by: Josh Matthews <[email protected]>

* Expose glue for using EnvironmentChain instances.

Signed-off-by: Josh Matthews <[email protected]>

* Match NDK requirements in CI.

Signed-off-by: Josh Matthews <[email protected]>

* Update mozilla-esr references and package version.

Signed-off-by: Josh Matthews <[email protected]>

* Add more packed attributes.

Signed-off-by: Josh Matthews <[email protected]>

* Work around Android build failure by removing failing static assert.

Signed-off-by: Josh Matthews <[email protected]>

* Display stderr/stdout output when build process fails.

Signed-off-by: Josh Matthews <[email protected]>

* Fix use of temporary file when testing ar support.

Signed-off-by: Josh Matthews <[email protected]>

* Use clang 16.

Signed-off-by: Josh Matthews <[email protected]>

* Ensure sysroot and minimum API level is provided when building on Android.

Signed-off-by: Josh Matthews <[email protected]>

* Comment out assertion that is not a constexpr in debug builds.

Signed-off-by: Josh Matthews <[email protected]>

* Allow integrity check to fail while mozjs source is unavailable.

Signed-off-by: Josh Matthews <[email protected]>

* Don't run patch integraity check.

Signed-off-by: Josh Matthews <[email protected]>

* Don't suppress diff when wrappers don't match.

Signed-off-by: Josh Matthews <[email protected]>

* Install llvm to.temp directory.

Co-authored-by: sagudev <[email protected]>
Signed-off-by: Josh Matthews <[email protected]>

---------

Signed-off-by: Josh Matthews <[email protected]>
Co-authored-by: sagudev <[email protected]>

Author: jdm

.github/workflows/build.yml

@@ -69,9 +69,11 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@stable
-      - name: Install deps
-        run: |
-          sudo apt install llvm -y
+      - name: Install LLVM and Clang
+        uses: KyleMayes/install-llvm-action@v2
+        with:
+          directory: ${{ runner.temp }}/llvm
+          version: "16.0"
       - name: Run sccache-cache
         uses: mozilla-actions/[email protected]
       - name: Build
@@ -84,7 +86,7 @@ jobs:
         run: |
           bash ./mozjs/src/generate_wrappers.sh
           git add --all .
-          git diff --staged --no-ext-diff --quiet --exit-code
+          git diff --staged --no-ext-diff --exit-code
 
       - name: Generate artifact attestation
         uses: actions/attest-build-provenance@v1
@@ -173,7 +175,7 @@ jobs:
         uses: nttld/setup-ndk@v1
         id: setup-ndk
         with:
-          ndk-version: r26c
+          ndk-version: r28
       - name: Install Rust
         uses: dtolnay/rust-toolchain@stable
         with:
@@ -259,21 +261,21 @@ jobs:
         with:
           clang-format-version: "18"
           exclude-regex: mozjs-sys\/mozjs
-      - name: Get mozjs
-        run: |
-          bash ./mozjs-sys/etc/get_mozjs.sh
-      - name: Apply patch
-        run: |
-          python3 ./mozjs-sys/etc/update.py --no-commit mozjs.tar.xz
-          # Run `git add` here to force CRLF converted into LF
-          # so that we can check diff properly in next run
-          git add --all mozjs-sys
-      - name: Check patch integrity
-        working-directory: ./mozjs-sys
-        # Because we've added files in previous run, we need to
-        # check diff with `--staged`.
-        run: |
-          git diff --staged --no-ext-diff --quiet --exit-code
+      #- name: Get mozjs
+      #  run: |
+      #    bash ./mozjs-sys/etc/get_mozjs.sh
+      #- name: Apply patch
+      #  run: |
+      #    python3 ./mozjs-sys/etc/update.py --no-commit mozjs.tar.xz
+      #    # Run `git add` here to force CRLF converted into LF
+      #    # so that we can check diff properly in next run
+      #    git add --all mozjs-sys
+      #- name: Check patch integrity
+      #  working-directory: ./mozjs-sys
+      #  # Because we've added files in previous run, we need to
+      #  # check diff with `--staged`.
+      #  run: |
+      #    git diff --staged --no-ext-diff --quiet --exit-code
       - name: Detect need for mozjs-sys version bump
         if: ${{ github.event_name == 'pull_request' }}
         id: changes

.github/workflows/release-check.yml

@@ -68,7 +68,7 @@ jobs:
         uses: nttld/setup-ndk@v1
         id: setup-ndk
         with:
-          ndk-version: r26c
+          ndk-version: r28
       - name: Install Rust
         uses: dtolnay/rust-toolchain@stable
         with:

README.md

@@ -6,8 +6,8 @@ that are battle-tested in [Servo](https://servo.org/), split in two crates:
 - `mozjs-sys`:  SpiderMonkey and low-level Rust bindings to its C++ API.
 - `mozjs`: Higher-level bindings to the SpiderMonkey API.
 
-Mozjs is currently tracking SpiderMonkey on [ESR-128](https://searchfox.org/mozilla-esr128/source/) branch
-(currently version 128.0).
+Mozjs is currently tracking SpiderMonkey on [mozilla-release](https://searchfox.org/mozilla-release/source/) branch
+(currently version 137.0).
 
 ## Building from Pre-built Archive
 
@@ -141,8 +141,8 @@ mozjs = { path = "../mozjs/mozjs" }
 
 In order to upgrade to a new version of SpiderMonkey:
 
-1. Find the mozilla-esr128 commit for the desired version of SpiderMonkey, at
-   <https://treeherder.mozilla.org/#/jobs?repo=mozilla-esr128&filter-searchStr=spidermonkey%20pkg>.
+1. Find the mozilla-release commit for the desired version of SpiderMonkey, at
+   <https://treeherder.mozilla.org/#/jobs?repo=mozilla-release&filter-searchStr=spidermonkey%20pkg>.
    You are looking for an SM(pkg) tagged with FIREFOX_RELEASE.
    Take a note of the commit number to the left (a hex number such as ac4fbb7aaca0).
 

android-build

@@ -12,7 +12,7 @@ import sys
 from typing import Dict, Optional
 
 
-SUPPORTED_NDK_VERSION = '26'
+SUPPORTED_NDK_VERSION = '28'
 API_LEVEL = '30'
 
 
@@ -41,7 +41,7 @@ def get_target_from_args() -> Optional[str]:
     return None 
 
 
-def set_toolchain_binaries_in_env(toolchain_dir: str, env: Dict[str, str]):
+def set_toolchain_binaries_in_env(toolchain_name: str, toolchain_dir: str, env: Dict[str, str]):
     cc = os.path.join(toolchain_dir, "bin", "clang")
     cxx = os.path.join(toolchain_dir, "bin", "clang++")
     ar = check_output([cc, "--print-prog-name=llvm-ar"])
@@ -65,6 +65,9 @@ def set_toolchain_binaries_in_env(toolchain_dir: str, env: Dict[str, str]):
     env["RANLIB"] = ranlib
     env["STRIP"] = strip
     env["YASM"] = yasm
+    env["CLANG_PATH"] = cc
+    env["LIBCLANG_PATH"] = os.path.join(toolchain_dir, "lib")
+    env["BINDGEN_EXTRA_CLANG_ARGS"] = f"--target={toolchain_name} --sysroot={os.path.join(toolchain_dir, 'sysroot')}"
 
 
 def create_environment_for_build() -> Dict[str, str]:
@@ -94,7 +97,13 @@ def create_environment_for_build() -> Dict[str, str]:
     toolchain_dir = os.path.join(ndk_home_dir, "toolchains", "llvm", "prebuilt", host_string)
     env['PATH'] = os.pathsep.join([os.path.join(toolchain_dir, "bin"), env["PATH"]])
 
-    set_toolchain_binaries_in_env(toolchain_dir, env)
+    toolchains_for_targets = {
+        "armv7-linux-androideabi": "armv7a-linux-androideabi",
+        "aarch64-linux-android": "aarch64-linux-android",
+        "x86_64-linux-android": "x86_64-linux-android",
+    }
+    toolchain_name = toolchains_for_targets[get_target_from_args()] + API_LEVEL
+    set_toolchain_binaries_in_env(toolchain_name, toolchain_dir, env)
 
     # This environment variable is only used by the mozjs build.
     env["ANDROID_API_LEVEL"] = API_LEVEL

mozjs-sys/Cargo.toml

@@ -2,7 +2,7 @@
 name = "mozjs_sys"
 description = "System crate for the Mozilla SpiderMonkey JavaScript engine."
 repository.workspace = true
-version = "0.128.13-3"
+version = "0.137.0-0"
 authors = ["Mozilla"]
 links = "mozjs"
 license.workspace = true

mozjs-sys/build.rs

@@ -204,9 +204,17 @@ fn build_spidermonkey(build_dir: &Path) {
         .current_dir(&build_dir)
         .env("SRC_DIR", &cargo_manifest_dir.join("mozjs"))
         .env("NO_RUST_PANIC_HOOK", "1")
-        .status()
+        .output()
         .expect(&format!("Failed to run `{:?}`", make));
-    assert!(result.success());
+    if !result.status.success() {
+        println!(
+            "stderr output:\n{}",
+            String::from_utf8(result.stderr).unwrap()
+        );
+        let stdout = String::from_utf8(result.stdout).unwrap();
+        println!("build output:\n{}", stdout,);
+    }
+    assert!(result.status.success());
 
     if target.contains("windows") {
         let mut make_static = cc::Build::new();
@@ -249,6 +257,10 @@ fn build(build_dir: &Path, target: BuildTarget) {
         build.flag_if_supported(flag);
     }
 
+    if let Ok(android_api) = env::var("ANDROID_API_LEVEL").as_deref() {
+        build.define("__ANDROID_MIN_SDK_VERSION__", android_api);
+    }
+
     build.flag(include_file_flag(build.get_compiler().is_like_msvc()));
     build.flag(&js_config_path(build_dir));
 
@@ -719,6 +731,11 @@ impl BuildTarget {
                 "JS::dbg::Builder_Object",
                 "JS::dbg::Builder_Object_Base",
                 "JS::dbg::BuilderOrigin",
+                "JS::RootedTuple",
+                "mozilla::external::AtomicRefCounted",
+                "mozilla::ProfilerStringView",
+                "mozilla::ProfilerString8View",
+                "mozilla::ProfilerString16View",
             ],
             BuildTarget::JSGlue => &[
                 "JS::.*",
@@ -785,6 +802,7 @@ impl BuildTarget {
     fn opaque_types(self) -> &'static [&'static str] {
         match self {
             BuildTarget::JSApi => &[
+                "JS::EnvironmentChain",
                 "JS::StackGCVector.*",
                 "JS::PersistentRooted.*",
                 "JS::detail::CallArgsBase",
@@ -797,6 +815,9 @@ impl BuildTarget {
                 "mozilla::detail::Hash.*",
                 "RefPtr_Proxy.*",
                 "std::.*",
+                "mozilla::baseprofiler::BaseProfilerProcessId",
+                "mozilla::baseprofiler::BaseProfilerThreadId",
+                "mozilla::MarkerThreadId",
             ],
             BuildTarget::JSGlue => &[
                 "JS::Auto.*Impl",

mozjs-sys/etc/COMMIT

@@ -1 +1 @@
-7bd1c6b763a2944873579523666acc0d2e23acd5
+7a8941c8c2cbdd3a4d352d8b732f7b5eeefbfd2d

mozjs-sys/etc/get_latest_mozjs.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-REPO=mozilla-esr128
+REPO=mozilla-release
 
 # get commit and appropriet mozjs tar
 jobs=( $(curl "https://treeherder.mozilla.org/api/project/$REPO/push/?full=true&count=20" | jq '.results[].id') )

mozjs-sys/etc/get_mozjs.sh

@@ -4,7 +4,7 @@ set -o errexit
 set -o nounset
 set -o pipefail
 
-REPO=mozilla-esr128
+REPO=mozilla-release
 
 SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 # get commit and appropriet mozjs tar

mozjs-sys/etc/patches/0009-Introduce-with-android-ndk-version-and-with-android-.patch

@@ -3,14 +3,14 @@ index 333a5ea499..8be5bc9052 100644
 --- a/build/moz.configure/android-ndk.configure
 +++ b/build/moz.configure/android-ndk.configure
 @@ -22,6 +22,10 @@ option(
-     help="location where the Android NDK can be found{|}",
+     help="Location where the Android NDK can be found{|}",
  )
 
 +option("--with-android-ndk-version", nargs=1, help="android NDK version")
 +
 +option("--with-android-platform", nargs=1, help="location of the Android platform")
 +
- option("--with-android-toolchain", nargs=1, help="location of the Android toolchain")
+ option("--with-android-toolchain", nargs=1, help="Location of the Android toolchain")
 
  option(
 @@ -89,17 +93,20 @@ def ndk(value):